diff --git a/apps/avatax/e2e/generated/types.ts b/apps/avatax/e2e/generated/types.ts index 0a1a933fce..ee4704164c 100644 --- a/apps/avatax/e2e/generated/types.ts +++ b/apps/avatax/e2e/generated/types.ts @@ -39,6 +39,8 @@ export type Scalars = { * String, Boolean, Int, Float, List or Object. */ GenericScalar: { input: any; output: any; } + /** The `Hour` scalar type represents number of hours by integer value. */ + Hour: { input: any; output: any; } JSON: { input: any; output: any; } JSONString: { input: any; output: any; } /** @@ -61,6 +63,12 @@ export type Scalars = { * Should be used in places where value must be nonnegative (0 or greater). */ PositiveDecimal: { input: any; output: any; } + /** + * Positive Integer scalar implementation. + * + * Should be used in places where value must be positive (greater than 0). + */ + PositiveInt: { input: any; output: any; } UUID: { input: any; output: any; } /** Variables of this type must be set to null in mutations. They will be replaced with a filename from a following multipart part containing a binary file. See: https://github.com/jaydenseric/graphql-multipart-request-spec. */ Upload: { input: any; output: any; } @@ -80,7 +88,7 @@ export type Scalars = { */ export type AccountAddressCreate = { __typename?: 'AccountAddressCreate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; address?: Maybe
; errors: Array; @@ -89,14 +97,14 @@ export type AccountAddressCreate = { }; /** - * Delete an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER. + * Deletes an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER. * * Triggers the following webhook events: * - ADDRESS_DELETED (async): An address was deleted. */ export type AccountAddressDelete = { __typename?: 'AccountAddressDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; address?: Maybe
; errors: Array; @@ -112,7 +120,7 @@ export type AccountAddressDelete = { */ export type AccountAddressUpdate = { __typename?: 'AccountAddressUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; address?: Maybe
; errors: Array; @@ -120,11 +128,7 @@ export type AccountAddressUpdate = { user?: Maybe; }; -/** - * Event sent when account change email is requested. - * - * Added in Saleor 3.15. - */ +/** Event sent when account change email is requested. */ export type AccountChangeEmailRequested = Event & { __typename?: 'AccountChangeEmailRequested'; /** The channel data. */ @@ -149,11 +153,7 @@ export type AccountChangeEmailRequested = Event & { version?: Maybe; }; -/** - * Event sent when account confirmation requested. This event is always sent. enableAccountConfirmationByEmail flag set to True is not required. - * - * Added in Saleor 3.15. - */ +/** Event sent when account confirmation requested. This event is always sent. enableAccountConfirmationByEmail flag set to True is not required. */ export type AccountConfirmationRequested = Event & { __typename?: 'AccountConfirmationRequested'; /** The channel data. */ @@ -176,11 +176,7 @@ export type AccountConfirmationRequested = Event & { version?: Maybe; }; -/** - * Event sent when account is confirmed. - * - * Added in Saleor 3.15. - */ +/** Event sent when account is confirmed. */ export type AccountConfirmed = Event & { __typename?: 'AccountConfirmed'; /** The channel data. */ @@ -213,17 +209,13 @@ export type AccountConfirmed = Event & { */ export type AccountDelete = { __typename?: 'AccountDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; user?: Maybe; }; -/** - * Event sent when account delete is requested. - * - * Added in Saleor 3.15. - */ +/** Event sent when account delete is requested. */ export type AccountDeleteRequested = Event & { __typename?: 'AccountDeleteRequested'; /** The channel data. */ @@ -246,11 +238,7 @@ export type AccountDeleteRequested = Event & { version?: Maybe; }; -/** - * Event sent when account is deleted. - * - * Added in Saleor 3.15. - */ +/** Event sent when account is deleted. */ export type AccountDeleted = Event & { __typename?: 'AccountDeleted'; /** The channel data. */ @@ -273,11 +261,7 @@ export type AccountDeleted = Event & { version?: Maybe; }; -/** - * Event sent when account email is changed. - * - * Added in Saleor 3.15. - */ +/** Event sent when account email is changed. */ export type AccountEmailChanged = Event & { __typename?: 'AccountEmailChanged'; /** The channel data. */ @@ -315,7 +299,6 @@ export type AccountError = { message?: Maybe; }; -/** An enumeration. */ export enum AccountErrorCode { AccountNotConfirmed = 'ACCOUNT_NOT_CONFIRMED', ActivateOwnAccount = 'ACTIVATE_OWN_ACCOUNT', @@ -368,9 +351,9 @@ export type AccountInput = { /** Family name. */ lastName?: InputMaybe; /** - * Fields required to update the user metadata. + * Fields required to update the user metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; }; @@ -385,11 +368,12 @@ export type AccountInput = { */ export type AccountRegister = { __typename?: 'AccountRegister'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** Informs whether users need to confirm their email address. */ requiresConfirmation?: Maybe; + /** @deprecated 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. */ user?: Maybe; }; @@ -405,7 +389,11 @@ export type AccountRegisterInput = { languageCode?: InputMaybe; /** Family name. */ lastName?: InputMaybe; - /** User public metadata. */ + /** + * User public metadata. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ metadata?: InputMaybe>; /** Password. */ password: Scalars['String']['input']; @@ -424,7 +412,7 @@ export type AccountRegisterInput = { */ export type AccountRequestDeletion = { __typename?: 'AccountRequestDeletion'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; }; @@ -439,18 +427,14 @@ export type AccountRequestDeletion = { */ export type AccountSetDefaultAddress = { __typename?: 'AccountSetDefaultAddress'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** An updated user instance. */ user?: Maybe; }; -/** - * Event sent when setting a new password is requested. - * - * Added in Saleor 3.15. - */ +/** Event sent when setting a new password is requested. */ export type AccountSetPasswordRequested = Event & { __typename?: 'AccountSetPasswordRequested'; /** The channel data. */ @@ -484,7 +468,7 @@ export type AccountSetPasswordRequested = Event & { */ export type AccountUpdate = { __typename?: 'AccountUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; user?: Maybe; @@ -513,49 +497,29 @@ export type Address = Node & ObjectWithMetadata & { isDefaultShippingAddress?: Maybe; /** The family name of the address. */ lastName: Scalars['String']['output']; - /** - * List of public metadata items. Can be accessed without permissions. - * - * Added in Saleor 3.10. - */ + /** List of public metadata items. Can be accessed without permissions. */ metadata: Array; /** * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.10. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.10. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** The phone number assigned the address. */ phone?: Maybe; /** The postal code of the address. */ postalCode: Scalars['String']['output']; - /** - * List of private metadata items. Requires staff permissions to access. - * - * Added in Saleor 3.10. - */ + /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; /** * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.10. */ 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. - * - * Added in Saleor 3.10. - */ + /** 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; /** The first line of the address. */ streetAddress1: Scalars['String']['output']; @@ -597,7 +561,7 @@ export type AddressPrivateMetafieldsArgs = { */ export type AddressCreate = { __typename?: 'AddressCreate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; address?: Maybe
; errors: Array; @@ -605,11 +569,7 @@ export type AddressCreate = { user?: Maybe; }; -/** - * Event sent when new address is created. - * - * Added in Saleor 3.5. - */ +/** Event sent when new address is created. */ export type AddressCreated = Event & { __typename?: 'AddressCreated'; /** The address the event relates to. */ @@ -634,7 +594,7 @@ export type AddressCreated = Event & { */ export type AddressDelete = { __typename?: 'AddressDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; address?: Maybe
; errors: Array; @@ -642,11 +602,7 @@ export type AddressDelete = { user?: Maybe; }; -/** - * Event sent when address is deleted. - * - * Added in Saleor 3.5. - */ +/** Event sent when address is deleted. */ export type AddressDeleted = Event & { __typename?: 'AddressDeleted'; /** The address the event relates to. */ @@ -661,6 +617,12 @@ export type AddressDeleted = Event & { version?: Maybe; }; +/** Filtering options for addresses. */ +export type AddressFilterInput = { + country?: InputMaybe; + phoneNumber?: InputMaybe; +}; + export type AddressInput = { /** City. */ city?: InputMaybe; @@ -677,9 +639,9 @@ export type AddressInput = { /** Family name. */ lastName?: InputMaybe; /** - * Address public metadata. + * Address public metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.15. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** @@ -714,14 +676,13 @@ export type AddressInput = { */ export type AddressSetDefault = { __typename?: 'AddressSetDefault'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** An updated user instance. */ user?: Maybe; }; -/** An enumeration. */ export enum AddressTypeEnum { Billing = 'BILLING', Shipping = 'SHIPPING' @@ -737,7 +698,7 @@ export enum AddressTypeEnum { */ export type AddressUpdate = { __typename?: 'AddressUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; address?: Maybe
; errors: Array; @@ -745,11 +706,7 @@ export type AddressUpdate = { user?: Maybe; }; -/** - * Event sent when address is updated. - * - * Added in Saleor 3.5. - */ +/** Event sent when address is updated. */ export type AddressUpdated = Event & { __typename?: 'AddressUpdated'; /** The address the event relates to. */ @@ -874,41 +831,37 @@ export type App = Node & ObjectWithMetadata & { accessToken?: Maybe; /** URL to iframe with the app. */ appUrl?: Maybe; + /** The App's author name. */ + author?: Maybe; + /** App's brand data. */ + brand?: Maybe; /** - * The App's author name. + * Circuit breaker last state change date. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Added in Saleor 3.21. */ - author?: Maybe; + breakerLastStateChange?: Maybe; /** - * App's brand data. - * - * Added in Saleor 3.14. + * Circuit breaker state, if open, sync webhooks operation is disrupted. * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Added in Saleor 3.21. */ - brand?: Maybe; + breakerState: CircuitBreakerStateEnum; /** * URL to iframe with the configuration for the app. - * @deprecated This field will be removed in Saleor 4.0. Use `appUrl` instead. + * @deprecated Use `appUrl` instead. */ configurationUrl?: Maybe; /** The date and time when the app was created. */ created?: Maybe; /** * Description of the data privacy defined for this app. - * @deprecated This field will be removed in Saleor 4.0. Use `dataPrivacyUrl` instead. + * @deprecated Use `dataPrivacyUrl` instead. */ dataPrivacy?: Maybe; /** URL to details about the privacy policy on the app owner page. */ dataPrivacyUrl?: Maybe; - /** - * App's dashboard extensions. - * - * Added in Saleor 3.1. - */ + /** App's dashboard extensions. */ extensions: Array; /** Homepage of the app. */ homepageUrl?: Maybe; @@ -922,11 +875,7 @@ export type App = Node & ObjectWithMetadata & { identifier?: Maybe; /** Determine if app will be set active or not. */ isActive?: Maybe; - /** - * URL to manifest used during app's installation. - * - * Added in Saleor 3.5. - */ + /** URL to manifest used during app's installation. */ manifestUrl?: Maybe; /** List of public metadata items. Can be accessed without permissions. */ metadata: Array; @@ -934,15 +883,9 @@ export type App = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Name of the app. */ name?: Maybe; @@ -954,15 +897,9 @@ export type App = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** Support page for the app. */ supportUrl?: Maybe; @@ -1019,57 +956,27 @@ export type AppPrivateMetafieldsArgs = { export type AppActivate = { __typename?: 'AppActivate'; app?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; errors: Array; }; -/** - * Represents the app's brand data. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the app's brand data. */ export type AppBrand = { __typename?: 'AppBrand'; - /** - * App's logos details. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** App's logos details. */ logo: AppBrandLogo; }; -/** - * Represents the app's brand logo data. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the app's brand logo data. */ export type AppBrandLogo = { __typename?: 'AppBrandLogo'; - /** - * URL to the default logo image. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** URL to the default logo image. */ default: Scalars['String']['output']; }; -/** - * Represents the app's brand logo data. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the app's brand logo data. */ export type AppBrandLogoDefaultArgs = { format?: InputMaybe; size?: InputMaybe; @@ -1101,7 +1008,7 @@ export type AppCountableEdge = { export type AppCreate = { __typename?: 'AppCreate'; app?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; /** The newly created authentication token. */ authToken?: Maybe; @@ -1119,7 +1026,7 @@ export type AppCreate = { export type AppDeactivate = { __typename?: 'AppDeactivate'; app?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; errors: Array; }; @@ -1135,29 +1042,25 @@ export type AppDeactivate = { export type AppDelete = { __typename?: 'AppDelete'; app?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; errors: Array; }; /** - * Delete failed installation. + * Deletes failed installation. * * Requires one of the following permissions: MANAGE_APPS. */ export type AppDeleteFailedInstallation = { __typename?: 'AppDeleteFailedInstallation'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; appInstallation?: Maybe; errors: Array; }; -/** - * Event sent when app is deleted. - * - * Added in Saleor 3.4. - */ +/** Event sent when app is deleted. */ export type AppDeleted = Event & { __typename?: 'AppDeleted'; /** The application the event relates to. */ @@ -1184,7 +1087,6 @@ export type AppError = { permissions?: Maybe>; }; -/** An enumeration. */ export enum AppErrorCode { Forbidden = 'FORBIDDEN', GraphqlError = 'GRAPHQL_ERROR', @@ -1214,12 +1116,43 @@ export type AppExtension = Node & { id: Scalars['ID']['output']; /** Label of the extension to show in the dashboard. */ label: Scalars['String']['output']; - /** Place where given extension will be mounted. */ + /** + * Place where given extension will be mounted. + * @deprecated Use `mountName` instead. + */ mount: AppExtensionMountEnum; + /** + * Name of the extension mount point in the dashboard. Replaces `mount` + * + * Added in Saleor 3.22. + */ + mountName: Scalars['String']['output']; + /** + * App extension options. + * + * Added in Saleor 3.22. + * @deprecated Use `settings` field instead. + */ + options?: Maybe; /** List of the app extension's permissions. */ permissions: Array; - /** Type of way how app extension will be opened. */ + /** + * App extension settings. Replaces `options` field. + * + * Added in Saleor 3.22. + */ + settings: Scalars['JSON']['output']; + /** + * Type of way how app extension will be opened. + * @deprecated Use `targetName` instead. + */ target: AppExtensionTargetEnum; + /** + * Name of the extension target in the dashboard. Replaces `target` + * + * Added in Saleor 3.22. + */ + targetName: Scalars['String']['output']; /** URL of a view where extension's iframe is placed. */ url: Scalars['String']['output']; }; @@ -1242,15 +1175,57 @@ export type AppExtensionCountableEdge = { }; export type AppExtensionFilterInput = { + /** + * DEPRECATED: Use `mountName` instead. + * @deprecated Field no longer supported + */ mount?: InputMaybe>; + /** + * Plain-text mount name (case insensitive) + * + * Added in Saleor 3.22. + */ + mountName?: InputMaybe>; + /** + * DEPRECATED: Use `targetName` instead. + * @deprecated Field no longer supported + */ target?: InputMaybe; + /** + * Plain-text target name (case insensitive) + * + * Added in Saleor 3.22. + */ + targetName?: InputMaybe; }; /** All places where app extension can be mounted. */ export enum AppExtensionMountEnum { + CategoryDetailsMoreActions = 'CATEGORY_DETAILS_MORE_ACTIONS', + CategoryOverviewCreate = 'CATEGORY_OVERVIEW_CREATE', + CategoryOverviewMoreActions = 'CATEGORY_OVERVIEW_MORE_ACTIONS', + CollectionDetailsMoreActions = 'COLLECTION_DETAILS_MORE_ACTIONS', + CollectionDetailsWidgets = 'COLLECTION_DETAILS_WIDGETS', + CollectionOverviewCreate = 'COLLECTION_OVERVIEW_CREATE', + CollectionOverviewMoreActions = 'COLLECTION_OVERVIEW_MORE_ACTIONS', CustomerDetailsMoreActions = 'CUSTOMER_DETAILS_MORE_ACTIONS', + CustomerDetailsWidgets = 'CUSTOMER_DETAILS_WIDGETS', CustomerOverviewCreate = 'CUSTOMER_OVERVIEW_CREATE', CustomerOverviewMoreActions = 'CUSTOMER_OVERVIEW_MORE_ACTIONS', + DiscountDetailsMoreActions = 'DISCOUNT_DETAILS_MORE_ACTIONS', + DiscountOverviewCreate = 'DISCOUNT_OVERVIEW_CREATE', + DiscountOverviewMoreActions = 'DISCOUNT_OVERVIEW_MORE_ACTIONS', + DraftOrderDetailsMoreActions = 'DRAFT_ORDER_DETAILS_MORE_ACTIONS', + DraftOrderDetailsWidgets = 'DRAFT_ORDER_DETAILS_WIDGETS', + DraftOrderOverviewCreate = 'DRAFT_ORDER_OVERVIEW_CREATE', + DraftOrderOverviewMoreActions = 'DRAFT_ORDER_OVERVIEW_MORE_ACTIONS', + GiftCardDetailsMoreActions = 'GIFT_CARD_DETAILS_MORE_ACTIONS', + GiftCardDetailsWidgets = 'GIFT_CARD_DETAILS_WIDGETS', + GiftCardOverviewCreate = 'GIFT_CARD_OVERVIEW_CREATE', + GiftCardOverviewMoreActions = 'GIFT_CARD_OVERVIEW_MORE_ACTIONS', + MenuDetailsMoreActions = 'MENU_DETAILS_MORE_ACTIONS', + MenuOverviewCreate = 'MENU_OVERVIEW_CREATE', + MenuOverviewMoreActions = 'MENU_OVERVIEW_MORE_ACTIONS', NavigationCatalog = 'NAVIGATION_CATALOG', NavigationCustomers = 'NAVIGATION_CUSTOMERS', NavigationDiscounts = 'NAVIGATION_DISCOUNTS', @@ -1258,13 +1233,48 @@ export enum AppExtensionMountEnum { NavigationPages = 'NAVIGATION_PAGES', NavigationTranslations = 'NAVIGATION_TRANSLATIONS', OrderDetailsMoreActions = 'ORDER_DETAILS_MORE_ACTIONS', + OrderDetailsWidgets = 'ORDER_DETAILS_WIDGETS', OrderOverviewCreate = 'ORDER_OVERVIEW_CREATE', OrderOverviewMoreActions = 'ORDER_OVERVIEW_MORE_ACTIONS', + PageDetailsMoreActions = 'PAGE_DETAILS_MORE_ACTIONS', + PageOverviewCreate = 'PAGE_OVERVIEW_CREATE', + PageOverviewMoreActions = 'PAGE_OVERVIEW_MORE_ACTIONS', + PageTypeDetailsMoreActions = 'PAGE_TYPE_DETAILS_MORE_ACTIONS', + PageTypeOverviewCreate = 'PAGE_TYPE_OVERVIEW_CREATE', + PageTypeOverviewMoreActions = 'PAGE_TYPE_OVERVIEW_MORE_ACTIONS', ProductDetailsMoreActions = 'PRODUCT_DETAILS_MORE_ACTIONS', + ProductDetailsWidgets = 'PRODUCT_DETAILS_WIDGETS', ProductOverviewCreate = 'PRODUCT_OVERVIEW_CREATE', - ProductOverviewMoreActions = 'PRODUCT_OVERVIEW_MORE_ACTIONS' + ProductOverviewMoreActions = 'PRODUCT_OVERVIEW_MORE_ACTIONS', + TranslationsMoreActions = 'TRANSLATIONS_MORE_ACTIONS', + VoucherDetailsMoreActions = 'VOUCHER_DETAILS_MORE_ACTIONS', + VoucherDetailsWidgets = 'VOUCHER_DETAILS_WIDGETS', + VoucherOverviewCreate = 'VOUCHER_OVERVIEW_CREATE', + VoucherOverviewMoreActions = 'VOUCHER_OVERVIEW_MORE_ACTIONS' } +/** Represents the options for an app extension. */ +export type AppExtensionOptionsNewTab = { + __typename?: 'AppExtensionOptionsNewTab'; + /** + * Options controlling behavior of the NEW_TAB extension target + * @deprecated Use `settings` field directly. + */ + newTabTarget?: Maybe; +}; + +/** Represents the options for an app extension. */ +export type AppExtensionOptionsWidget = { + __typename?: 'AppExtensionOptionsWidget'; + /** + * Options for displaying a Widget + * @deprecated Use `settings` field directly. + */ + widgetTarget?: Maybe; +}; + +export type AppExtensionPossibleOptions = AppExtensionOptionsNewTab | AppExtensionOptionsWidget; + /** * All available ways of opening an app extension. * @@ -1273,7 +1283,9 @@ export enum AppExtensionMountEnum { */ export enum AppExtensionTargetEnum { AppPage = 'APP_PAGE', - Popup = 'POPUP' + NewTab = 'NEW_TAB', + Popup = 'POPUP', + Widget = 'WIDGET' } /** @@ -1283,7 +1295,7 @@ export enum AppExtensionTargetEnum { */ export type AppFetchManifest = { __typename?: 'AppFetchManifest'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; errors: Array; /** The validated manifest. */ @@ -1312,7 +1324,7 @@ export type AppInput = { /** Install new app by using app manifest. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS. */ export type AppInstall = { __typename?: 'AppInstall'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; appInstallation?: Maybe; errors: Array; @@ -1334,13 +1346,7 @@ export type AppInstallation = Job & Node & { __typename?: 'AppInstallation'; /** The name of the app installation. */ appName: Scalars['String']['output']; - /** - * App's brand data. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** App's brand data. */ brand?: Maybe; /** Created date time of job in ISO 8601 format. */ createdAt: Scalars['DateTime']['output']; @@ -1356,11 +1362,7 @@ export type AppInstallation = Job & Node & { updatedAt: Scalars['DateTime']['output']; }; -/** - * Event sent when new app is installed. - * - * Added in Saleor 3.4. - */ +/** Event sent when new app is installed. */ export type AppInstalled = Event & { __typename?: 'AppInstalled'; /** The application the event relates to. */ @@ -1375,52 +1377,22 @@ export type AppInstalled = Event & { version?: Maybe; }; -/** - * Represents the app's manifest brand data. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the app's manifest brand data. */ export type AppManifestBrand = { __typename?: 'AppManifestBrand'; - /** - * App's logos details. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** App's logos details. */ logo: AppManifestBrandLogo; }; -/** - * Represents the app's manifest brand data. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the app's manifest brand data. */ export type AppManifestBrandLogo = { __typename?: 'AppManifestBrandLogo'; - /** - * Data URL with a base64 encoded logo image. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Data URL with a base64 encoded logo image. */ default: Scalars['String']['output']; }; -/** - * Represents the app's manifest brand data. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the app's manifest brand data. */ export type AppManifestBrandLogoDefaultArgs = { format?: InputMaybe; size?: InputMaybe; @@ -1430,33 +1402,45 @@ export type AppManifestExtension = { __typename?: 'AppManifestExtension'; /** Label of the extension to show in the dashboard. */ label: Scalars['String']['output']; - /** Place where given extension will be mounted. */ + /** + * Place where given extension will be mounted. + * @deprecated Use `mountName` instead. + */ mount: AppExtensionMountEnum; + /** + * Name of the extension mount point in the dashboard. Replaces `mount` + * + * Added in Saleor 3.22. + */ + mountName: Scalars['String']['output']; /** List of the app extension's permissions. */ permissions: Array; - /** Type of way how app extension will be opened. */ + /** + * JSON object with settings for this extension. + * + * Added in Saleor 3.22. + */ + settings: Scalars['JSON']['output']; + /** + * Type of way how app extension will be opened. + * @deprecated Use `targetName` instead. + */ target: AppExtensionTargetEnum; + /** + * Name of the extension target in the dashboard. Replaces `target` + * + * Added in Saleor 3.22. + */ + targetName: Scalars['String']['output']; /** URL of a view where extension's iframe is placed. */ url: Scalars['String']['output']; }; export type AppManifestRequiredSaleorVersion = { __typename?: 'AppManifestRequiredSaleorVersion'; - /** - * Required Saleor version as semver range. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Required Saleor version as semver range. */ constraint: Scalars['String']['output']; - /** - * Informs if the Saleor version matches the required one. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Informs if the Saleor version matches the required one. */ satisfied: Scalars['Boolean']['output']; }; @@ -1474,6 +1458,22 @@ export type AppManifestWebhook = { targetUrl: Scalars['String']['output']; }; +/** + * 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. + * + * Requires one of the following permissions: MANAGE_APPS. + */ +export type AppReenableSyncWebhooks = { + __typename?: 'AppReenableSyncWebhooks'; + /** App for which sync webhooks were re-enabled. */ + app?: Maybe; + /** @deprecated Use `errors` field instead. */ + appErrors: Array; + errors: Array; +}; + /** * Retry failed installation of new app. * @@ -1484,7 +1484,7 @@ export type AppManifestWebhook = { */ export type AppRetryInstall = { __typename?: 'AppRetryInstall'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; appInstallation?: Maybe; errors: Array; @@ -1504,11 +1504,7 @@ export type AppSortingInput = { field: AppSortField; }; -/** - * Event sent when app status has changed. - * - * Added in Saleor 3.4. - */ +/** Event sent when app status has changed. */ export type AppStatusChanged = Event & { __typename?: 'AppStatusChanged'; /** The application the event relates to. */ @@ -1541,7 +1537,7 @@ export type AppToken = Node & { */ export type AppTokenCreate = { __typename?: 'AppTokenCreate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; appToken?: Maybe; /** The newly created authentication token. */ @@ -1556,7 +1552,7 @@ export type AppTokenCreate = { */ export type AppTokenDelete = { __typename?: 'AppTokenDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; appToken?: Maybe; errors: Array; @@ -1572,7 +1568,7 @@ export type AppTokenInput = { /** Verify provided app token. */ export type AppTokenVerify = { __typename?: 'AppTokenVerify'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; errors: Array; /** Determine if token is valid or not. */ @@ -1598,16 +1594,12 @@ export enum AppTypeEnum { export type AppUpdate = { __typename?: 'AppUpdate'; app?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; errors: Array; }; -/** - * Event sent when app is updated. - * - * Added in Saleor 3.4. - */ +/** Event sent when app is updated. */ export type AppUpdated = Event & { __typename?: 'AppUpdated'; /** The application the event relates to. */ @@ -1622,7 +1614,6 @@ export type AppUpdated = Event & { version?: Maybe; }; -/** An enumeration. */ export enum AreaUnitsEnum { SqCm = 'SQ_CM', SqDm = 'SQ_DM', @@ -1644,67 +1635,488 @@ export type AssignNavigation = { errors: Array; /** Assigned navigation menu. */ menu?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; }; /** - * Represents assigned attribute to variant with variant selection attached. + * Represents an attribute assigned to an object. * - * Added in Saleor 3.1. + * Added in Saleor 3.22. */ -export type AssignedVariantAttribute = { - __typename?: 'AssignedVariantAttribute'; - /** Attribute assigned to variant. */ +export type AssignedAttribute = { + /** Attribute assigned to an object. */ attribute: Attribute; - /** Determines, whether assigned attribute is allowed for variant selection. Supported variant types for variant selection are: ['dropdown', 'boolean', 'swatch', 'numeric'] */ - variantSelection: Scalars['Boolean']['output']; }; -/** Custom attribute of a product. Attributes can be assigned to products and variants at the product type level. */ -export type Attribute = Node & ObjectWithMetadata & { - __typename?: 'Attribute'; - /** - * 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. - * @deprecated This field will be removed in Saleor 4.0. - */ - availableInGrid: Scalars['Boolean']['output']; - /** List of attribute's values. */ - choices?: Maybe; - /** The entity type which can be used as a reference. */ - entityType?: Maybe; - /** - * External ID of this attribute. - * - * Added in Saleor 3.10. - */ - externalReference?: Maybe; - /** Whether the attribute can be filtered in dashboard. Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES, MANAGE_PRODUCTS, MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. */ - filterableInDashboard: Scalars['Boolean']['output']; - /** - * 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. - * @deprecated This field will be removed in Saleor 4.0. - */ - filterableInStorefront: Scalars['Boolean']['output']; - /** The ID of the attribute. */ - id: Scalars['ID']['output']; - /** The input type to use for entering attribute values in the dashboard. */ - inputType?: Maybe; - /** List of public metadata items. Can be accessed without permissions. */ - metadata: Array; - /** - * A single key from public metadata. - * - * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. - */ - metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. +export type AssignedAttributeReferenceInput = { + /** Returns objects with a reference pointing to a category identified by the given slug. */ + categorySlugs?: InputMaybe; + /** Returns objects with a reference pointing to a collection identified by the given slug. */ + collectionSlugs?: InputMaybe; + /** Returns objects with a reference pointing to a page identified by the given slug. */ + pageSlugs?: InputMaybe; + /** Returns objects with a reference pointing to a product identified by the given slug. */ + productSlugs?: InputMaybe; + /** Returns objects with a reference pointing to a product variant identified by the given sku. */ + productVariantSkus?: InputMaybe; + /** Returns objects with a reference pointing to an object identified by the given ID. */ + referencedIds?: InputMaybe; +}; + +export type AssignedAttributeValueInput = { + /** Filter by boolean value for attributes of boolean type. */ + boolean?: InputMaybe; + /** Filter by date value for attributes of date type. */ + date?: InputMaybe; + /** Filter by date time value for attributes of date time type. */ + dateTime?: InputMaybe; + /** Filter by name assigned to AttributeValue. */ + name?: InputMaybe; + /** Filter by numeric value for attributes of numeric type. */ + numeric?: InputMaybe; + /** Filter by reference attribute value. */ + reference?: InputMaybe; + /** Filter by slug assigned to AttributeValue. */ + slug?: InputMaybe; +}; + +export type AssignedAttributeWhereInput = { + /** Filter by attribute slug. */ + 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. */ + value?: InputMaybe; +}; + +/** + * Represents a boolean attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedBooleanAttribute = AssignedAttribute & { + __typename?: 'AssignedBooleanAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned boolean value. */ + value?: Maybe; +}; + +/** + * Represents a single choice value of the attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedChoiceAttributeValue = { + __typename?: 'AssignedChoiceAttributeValue'; + /** Name of a value displayed in the interface. */ + name?: Maybe; + /** Internal representation of a value (unique per attribute). */ + slug?: Maybe; + /** Translation of the name. */ + translation?: Maybe; +}; + + +/** + * Represents a single choice value of the attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedChoiceAttributeValueTranslationArgs = { + languageCode: LanguageCodeEnum; +}; + +/** + * Represents a date attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedDateAttribute = AssignedAttribute & { + __typename?: 'AssignedDateAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned date value. */ + value?: Maybe; +}; + +/** + * Represents a date time attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedDateTimeAttribute = AssignedAttribute & { + __typename?: 'AssignedDateTimeAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned date time value. */ + value?: Maybe; +}; + +/** + * Represents file attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedFileAttribute = AssignedAttribute & { + __typename?: 'AssignedFileAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned file. */ + value?: Maybe; +}; + +/** + * Represents multi category reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiCategoryReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedMultiCategoryReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** List of assigned category references. */ + value: Array; +}; + + +/** + * Represents multi category reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiCategoryReferenceAttributeValueArgs = { + limit?: InputMaybe; +}; + +/** + * Represents a multi choice attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiChoiceAttribute = AssignedAttribute & { + __typename?: 'AssignedMultiChoiceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** List of assigned choice values. */ + value: Array; +}; + + +/** + * Represents a multi choice attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiChoiceAttributeValueArgs = { + limit?: InputMaybe; +}; + +/** + * Represents multi collection reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiCollectionReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedMultiCollectionReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** List of assigned collection references. */ + value: Array; +}; + + +/** + * Represents multi collection reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiCollectionReferenceAttributeValueArgs = { + limit?: InputMaybe; +}; + +/** + * Represents multi page reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiPageReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedMultiPageReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** List of assigned page references. */ + value: Array; +}; + + +/** + * Represents multi page reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiPageReferenceAttributeValueArgs = { + limit?: InputMaybe; +}; + +/** + * Represents multi product reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiProductReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedMultiProductReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** List of assigned product references. */ + value: Array; +}; + + +/** + * Represents multi product reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiProductReferenceAttributeValueArgs = { + limit?: InputMaybe; +}; + +/** + * Represents multi product variant reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiProductVariantReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedMultiProductVariantReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** List of assigned product variant references. */ + value: Array; +}; + + +/** + * Represents multi product variant reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiProductVariantReferenceAttributeValueArgs = { + limit?: InputMaybe; +}; + +/** + * Represents a numeric value of an attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedNumericAttribute = AssignedAttribute & { + __typename?: 'AssignedNumericAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned numeric value. */ + value?: Maybe; +}; + +/** + * Represents plain text attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedPlainTextAttribute = AssignedAttribute & { + __typename?: 'AssignedPlainTextAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** Translation of the plain text content in the specified language. */ + translation?: Maybe; + /** The assigned plain text content. */ + value?: Maybe; +}; + + +/** + * Represents plain text attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedPlainTextAttributeTranslationArgs = { + languageCode: LanguageCodeEnum; +}; + +/** + * Represents single category reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedSingleCategoryReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedSingleCategoryReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned category reference. */ + value?: Maybe; +}; + +/** + * Represents a single choice attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedSingleChoiceAttribute = AssignedAttribute & { + __typename?: 'AssignedSingleChoiceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned choice value. */ + value?: Maybe; +}; + +/** + * Represents single collection reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedSingleCollectionReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedSingleCollectionReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned collection reference. */ + value?: Maybe; +}; + +/** + * Represents single page reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedSinglePageReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedSinglePageReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned page reference. */ + value?: Maybe; +}; + +/** + * Represents single product reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedSingleProductReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedSingleProductReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned product reference. */ + value?: Maybe; +}; + +/** + * Represents single product variant reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedSingleProductVariantReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedSingleProductVariantReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned product variant reference. */ + value?: Maybe; +}; + +/** + * Represents a swatch attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedSwatchAttribute = AssignedAttribute & { + __typename?: 'AssignedSwatchAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned swatch value. */ + value?: Maybe; +}; + +/** + * Represents a single swatch value. + * + * Added in Saleor 3.22. + */ +export type AssignedSwatchAttributeValue = { + __typename?: 'AssignedSwatchAttributeValue'; + /** File associated with the attribute. */ + file?: Maybe; + /** Hex color code. */ + hexColor?: Maybe; + /** Name of the selected swatch value. */ + name?: Maybe; + /** Slug of the selected swatch value. */ + slug?: Maybe; +}; + +/** + * Represents text attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedTextAttribute = AssignedAttribute & { + __typename?: 'AssignedTextAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** Translation of the rich text content in the specified language. */ + translation?: Maybe; + /** The assigned rich text content. */ + value?: Maybe; +}; + + +/** + * Represents text attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedTextAttributeTranslationArgs = { + languageCode: LanguageCodeEnum; +}; + +/** Represents assigned attribute to variant with variant selection attached. */ +export type AssignedVariantAttribute = { + __typename?: 'AssignedVariantAttribute'; + /** Attribute assigned to variant. */ + attribute: Attribute; + /** Determines, whether assigned attribute is allowed for variant selection. Supported variant types for variant selection are: ['dropdown', 'boolean', 'swatch', 'numeric'] */ + variantSelection: Scalars['Boolean']['output']; +}; + +/** Custom attribute of a product. Attributes can be assigned to products and variants at the product type level. */ +export type Attribute = Node & ObjectWithMetadata & { + __typename?: 'Attribute'; + /** + * 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. + * @deprecated Field no longer supported + */ + availableInGrid: Scalars['Boolean']['output']; + /** A list of predefined attribute choices available for selection. Available only for attributes with predefined choices. */ + choices?: Maybe; + /** The entity type which can be used as a reference. */ + entityType?: Maybe; + /** External ID of this attribute. */ + externalReference?: Maybe; + /** Whether the attribute can be filtered in dashboard. Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES, MANAGE_PRODUCTS, MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. */ + filterableInDashboard: Scalars['Boolean']['output']; + /** + * 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. + * @deprecated Field no longer supported */ + filterableInStorefront: Scalars['Boolean']['output']; + /** The ID of the attribute. */ + id: Scalars['ID']['output']; + /** The input type to use for entering attribute values in the dashboard. */ + inputType?: Maybe; + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array; + /** + * A single key from public metadata. + * + * Tip: Use GraphQL aliases to fetch multiple keys. + */ + metafield?: Maybe; + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Name of an attribute displayed in the interface. */ name?: Maybe; @@ -1714,25 +2126,25 @@ export type Attribute = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** A list of product types that use this attribute as a product attribute. */ productTypes: ProductTypeCountableConnection; /** A list of product types that use this attribute as a product variant attribute. */ productVariantTypes: ProductTypeCountableConnection; + /** + * The reference types (product or page type) that are used to narrow down the choices of reference objects. + * + * Added in Saleor 3.22. + */ + referenceTypes?: Maybe>; /** Internal representation of an attribute name. */ slug?: Maybe; /** * 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. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ storefrontSearchPosition: Scalars['Int']['output']; /** Returns translated attribute fields for the given language code. */ @@ -1757,7 +2169,9 @@ export type AttributeChoicesArgs = { filter?: InputMaybe; first?: InputMaybe; last?: InputMaybe; + search?: InputMaybe; sortBy?: InputMaybe; + where?: InputMaybe; }; @@ -1803,6 +2217,12 @@ export type AttributeProductVariantTypesArgs = { }; +/** Custom attribute of a product. Attributes can be assigned to products and variants at the product type level. */ +export type AttributeReferenceTypesArgs = { + limit?: InputMaybe; +}; + + /** Custom attribute of a product. Attributes can be assigned to products and variants at the product type level. */ export type AttributeTranslationArgs = { languageCode: LanguageCodeEnum; @@ -1811,10 +2231,6 @@ export type AttributeTranslationArgs = { /** * Creates attributes. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Triggers the following webhook events: * - ATTRIBUTE_CREATED (async): An attribute was created. */ @@ -1837,7 +2253,6 @@ export type AttributeBulkCreateError = { path?: Maybe; }; -/** An enumeration. */ export enum AttributeBulkCreateErrorCode { AlreadyExists = 'ALREADY_EXISTS', Blank = 'BLANK', @@ -1868,7 +2283,7 @@ export type AttributeBulkCreateResult = { */ export type AttributeBulkDelete = { __typename?: 'AttributeBulkDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ attributeErrors: Array; /** Returns how many objects were affected. */ count: Scalars['Int']['output']; @@ -1878,10 +2293,6 @@ export type AttributeBulkDelete = { /** * Creates/updates translations for attributes. * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. */ export type AttributeBulkTranslate = { @@ -1925,10 +2336,6 @@ export type AttributeBulkTranslateResult = { /** * Updates attributes. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Triggers the following webhook events: * - ATTRIBUTE_UPDATED (async): An attribute was updated. Optionally called when new attribute value was created or deleted. * - ATTRIBUTE_VALUE_CREATED (async): Called optionally when an attribute value was created. @@ -1953,7 +2360,6 @@ export type AttributeBulkUpdateError = { path?: Maybe; }; -/** An enumeration. */ export enum AttributeBulkUpdateErrorCode { AlreadyExists = 'ALREADY_EXISTS', Blank = 'BLANK', @@ -2022,8 +2428,9 @@ export type AttributeCountableEdge = { */ export type AttributeCreate = { __typename?: 'AttributeCreate'; + /** The created attribute. */ attribute?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ attributeErrors: Array; errors: Array; }; @@ -2036,24 +2443,18 @@ export type AttributeCreate = { export type AttributeCreateInput = { /** * Whether the attribute can be displayed in the admin product list. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ availableInGrid?: InputMaybe; /** The entity type which can be used as a reference. */ entityType?: InputMaybe; - /** - * External ID of this attribute. - * - * Added in Saleor 3.10. - */ + /** External ID of this attribute. */ externalReference?: InputMaybe; /** Whether the attribute can be filtered in dashboard. */ filterableInDashboard?: InputMaybe; /** * Whether the attribute can be filtered in storefront. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ filterableInStorefront?: InputMaybe; /** The input type to use for entering attribute values in the dashboard. */ @@ -2062,12 +2463,19 @@ export type AttributeCreateInput = { isVariantOnly?: InputMaybe; /** Name of an attribute displayed in the interface. */ name: Scalars['String']['input']; + /** + * Specifies reference types to narrow down the choices of reference objects. Applicable only for `REFERENCE` and `SINGLE_REFERENCE` attributes with `PRODUCT`, `PRODUCT_VARIANT` and `PAGE` entity types. Accepts `ProductType` IDs for `PRODUCT` and `PRODUCT_VARIANT` entity types, and `PageType` IDs for `PAGE` entity type. If omitted, all objects of the selected entity type are available as attribute values. + * + * A maximum of 100 reference types can be specified. + * + * Added in Saleor 3.22. + */ + referenceTypes?: InputMaybe>; /** Internal representation of an attribute name. */ slug?: InputMaybe; /** * The position of the attribute in the storefront navigation (0 by default). - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ storefrontSearchPosition?: InputMaybe; /** The attribute type. */ @@ -2082,11 +2490,7 @@ export type AttributeCreateInput = { visibleInStorefront?: InputMaybe; }; -/** - * Event sent when new attribute is created. - * - * Added in Saleor 3.5. - */ +/** Event sent when new attribute is created. */ export type AttributeCreated = Event & { __typename?: 'AttributeCreated'; /** The attribute the event relates to. */ @@ -2112,16 +2516,12 @@ export type AttributeCreated = Event & { export type AttributeDelete = { __typename?: 'AttributeDelete'; attribute?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ attributeErrors: Array; errors: Array; }; -/** - * Event sent when attribute is deleted. - * - * Added in Saleor 3.5. - */ +/** Event sent when attribute is deleted. */ export type AttributeDeleted = Event & { __typename?: 'AttributeDeleted'; /** The attribute the event relates to. */ @@ -2136,8 +2536,9 @@ export type AttributeDeleted = Event & { version?: Maybe; }; -/** An enumeration. */ export enum AttributeEntityTypeEnum { + Category = 'CATEGORY', + Collection = 'COLLECTION', Page = 'PAGE', Product = 'PRODUCT', ProductVariant = 'PRODUCT_VARIANT' @@ -2160,7 +2561,6 @@ export type AttributeError = { message?: Maybe; }; -/** An enumeration. */ export enum AttributeErrorCode { AlreadyExists = 'ALREADY_EXISTS', GraphqlError = 'GRAPHQL_ERROR', @@ -2174,8 +2574,7 @@ export type AttributeFilterInput = { availableInGrid?: InputMaybe; /** * Specifies the channel by which the data should be filtered. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. + * @deprecated Use root-level channel argument instead. */ channel?: InputMaybe; filterableInDashboard?: InputMaybe; @@ -2193,21 +2592,37 @@ export type AttributeFilterInput = { }; export type AttributeInput = { - /** The boolean value of the attribute. */ + /** + * The boolean value of the attribute. Requires `slug` to be provided. + * @deprecated 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. */ + /** + * 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. + */ date?: InputMaybe; - /** The date/time range that the returned values should be in. */ + /** + * The date/time range that the returned values should be in. Requires `slug` to be provided. + * @deprecated Use `value` instead. + */ dateTime?: InputMaybe; /** Internal representation of an attribute name. */ - slug: Scalars['String']['input']; - /** Internal representation of a value (unique per attribute). */ + 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`. */ + 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. + */ values?: InputMaybe>; - /** The range that the returned values should be in. */ + /** + * The range that the returned values should be in. Requires `slug` to be provided. + * @deprecated Use `value` instead. + */ valuesRange?: InputMaybe; }; -/** An enumeration. */ export enum AttributeInputTypeEnum { Boolean = 'BOOLEAN', Date = 'DATE', @@ -2219,6 +2634,7 @@ export enum AttributeInputTypeEnum { PlainText = 'PLAIN_TEXT', Reference = 'REFERENCE', RichText = 'RICH_TEXT', + SingleReference = 'SINGLE_REFERENCE', Swatch = 'SWATCH' } @@ -2242,7 +2658,7 @@ export type AttributeReorderValues = { __typename?: 'AttributeReorderValues'; /** Attribute from which values are reordered. */ attribute?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ attributeErrors: Array; errors: Array; }; @@ -2280,14 +2696,10 @@ export type AttributeTranslatableContent = Node & { __typename?: 'AttributeTranslatableContent'; /** * Custom attribute of a product. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ attribute?: Maybe; - /** - * The ID of the attribute to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the attribute to translate. */ attributeId: Scalars['ID']['output']; /** The ID of the attribute translatable content. */ id: Scalars['ID']['output']; @@ -2312,11 +2724,10 @@ export type AttributeTranslate = { __typename?: 'AttributeTranslate'; attribute?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; -/** An enumeration. */ export enum AttributeTranslateErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', @@ -2333,15 +2744,10 @@ export type AttributeTranslation = Node & { language: LanguageDisplay; /** Translated attribute name. */ name: Scalars['String']['output']; - /** - * Represents the attribute fields to translate. - * - * Added in Saleor 3.14. - */ + /** Represents the attribute fields to translate. */ translatableContent?: Maybe; }; -/** An enumeration. */ export enum AttributeTypeEnum { PageType = 'PAGE_TYPE', ProductType = 'PRODUCT_TYPE' @@ -2364,8 +2770,9 @@ export type AttributeTypeEnumFilterInput = { */ export type AttributeUpdate = { __typename?: 'AttributeUpdate'; + /** The updated attribute. */ attribute?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ attributeErrors: Array; errors: Array; }; @@ -2380,36 +2787,37 @@ export type AttributeUpdateInput = { addValues?: InputMaybe>; /** * Whether the attribute can be displayed in the admin product list. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ availableInGrid?: InputMaybe; - /** - * External ID of this product. - * - * Added in Saleor 3.10. - */ + /** External ID of this product. */ externalReference?: InputMaybe; /** Whether the attribute can be filtered in dashboard. */ filterableInDashboard?: InputMaybe; /** * Whether the attribute can be filtered in storefront. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ filterableInStorefront?: InputMaybe; /** Whether the attribute is for variants only. */ isVariantOnly?: InputMaybe; /** Name of an attribute displayed in the interface. */ name?: InputMaybe; + /** + * Specifies reference types to narrow down the choices of reference objects. Applicable only for `REFERENCE` and `SINGLE_REFERENCE` attributes with `PRODUCT`, `PRODUCT_VARIANT` and `PAGE` entity types. Accepts `ProductType` IDs for `PRODUCT` and `PRODUCT_VARIANT` entity types, and `PageType` IDs for `PAGE` entity type. If omitted, all objects of the selected entity type are available as attribute values. + * + * A maximum of 100 reference types can be specified. + * + * Added in Saleor 3.22. + */ + referenceTypes?: InputMaybe>; /** IDs of values to be removed from this attribute. */ removeValues?: InputMaybe>; /** Internal representation of an attribute name. */ slug?: InputMaybe; /** * The position of the attribute in the storefront navigation (0 by default). - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ storefrontSearchPosition?: InputMaybe; /** The unit of attribute values. */ @@ -2420,11 +2828,7 @@ export type AttributeUpdateInput = { visibleInStorefront?: InputMaybe; }; -/** - * Event sent when attribute is updated. - * - * Added in Saleor 3.5. - */ +/** Event sent when attribute is updated. */ export type AttributeUpdated = Event & { __typename?: 'AttributeUpdated'; /** The attribute the event relates to. */ @@ -2448,11 +2852,7 @@ export type AttributeValue = Node & { date?: Maybe; /** Represents the date/time value of the attribute value. */ dateTime?: Maybe; - /** - * External ID of this attribute value. - * - * Added in Saleor 3.10. - */ + /** External ID of this attribute value. */ externalReference?: Maybe; /** Represents file URL and content type (if attribute value is a file). */ file?: Maybe; @@ -2464,7 +2864,7 @@ export type AttributeValue = Node & { name?: Maybe; /** Represents the text of the attribute value, plain text without formatting. */ plainText?: Maybe; - /** The ID of the attribute reference. */ + /** The ID of the referenced object. */ reference?: Maybe; /** * Represents the text of the attribute value, includes formatting. @@ -2497,7 +2897,7 @@ export type AttributeValueTranslationArgs = { */ export type AttributeValueBulkDelete = { __typename?: 'AttributeValueBulkDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ attributeErrors: Array; /** Returns how many objects were affected. */ count: Scalars['Int']['output']; @@ -2505,11 +2905,7 @@ export type AttributeValueBulkDelete = { }; /** - * Creates/updates translations for attributes values. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Creates/updates translations for attribute values. * * Requires one of the following permissions: MANAGE_TRANSLATIONS. */ @@ -2581,7 +2977,7 @@ export type AttributeValueCreate = { __typename?: 'AttributeValueCreate'; /** The updated attribute. */ attribute?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ attributeErrors: Array; attributeValue?: Maybe; errors: Array; @@ -2590,11 +2986,7 @@ export type AttributeValueCreate = { export type AttributeValueCreateInput = { /** File content type. */ contentType?: InputMaybe; - /** - * External ID of this attribute value. - * - * Added in Saleor 3.10. - */ + /** External ID of this attribute value. */ externalReference?: InputMaybe; /** URL of the file attribute. Every time, a new value is created. */ fileUrl?: InputMaybe; @@ -2602,27 +2994,21 @@ export type AttributeValueCreateInput = { name: Scalars['String']['input']; /** * Represents the text of the attribute value, plain text without formatting. - * - * DEPRECATED: this field will be removed in Saleor 4.0.The plain text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute. + * @deprecated 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: this field will be removed in Saleor 4.0.The rich text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute. + * @deprecated 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). */ value?: InputMaybe; }; -/** - * Event sent when new attribute value is created. - * - * Added in Saleor 3.5. - */ +/** Event sent when new attribute value is created. */ export type AttributeValueCreated = Event & { __typename?: 'AttributeValueCreated'; /** The attribute value the event relates to. */ @@ -2650,17 +3036,13 @@ export type AttributeValueDelete = { __typename?: 'AttributeValueDelete'; /** The updated attribute. */ attribute?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ attributeErrors: Array; attributeValue?: Maybe; errors: Array; }; -/** - * Event sent when attribute value is deleted. - * - * Added in Saleor 3.5. - */ +/** Event sent when attribute value is deleted. */ export type AttributeValueDeleted = Event & { __typename?: 'AttributeValueDeleted'; /** The attribute value the event relates to. */ @@ -2690,47 +3072,36 @@ export type AttributeValueInput = { date?: InputMaybe; /** Represents the date/time value of the attribute value. */ dateTime?: InputMaybe; - /** - * Attribute value ID or external reference. - * - * Added in Saleor 3.9. - */ + /** Attribute value ID or external reference. */ dropdown?: InputMaybe; - /** - * External ID of this attribute. - * - * Added in Saleor 3.14. - */ + /** External ID of this attribute. */ externalReference?: InputMaybe; /** URL of the file attribute. Every time, a new value is created. */ file?: InputMaybe; /** ID of the selected attribute. */ id?: InputMaybe; - /** - * List of attribute value IDs or external references. - * - * Added in Saleor 3.9. - */ + /** List of attribute value IDs or external references. */ multiselect?: InputMaybe>; - /** - * Numeric value of an attribute. - * - * Added in Saleor 3.9. - */ + /** Numeric value of an attribute. */ numeric?: InputMaybe; /** Plain text content. */ plainText?: InputMaybe; + /** + * ID of the referenced entity for single reference attribute. + * + * Added in Saleor 3.22. + */ + reference?: InputMaybe; /** List of entity IDs that will be used as references. */ references?: InputMaybe>; /** Text content in JSON format. */ richText?: InputMaybe; + /** Attribute value ID or external reference. */ + swatch?: InputMaybe; /** - * Attribute value ID or external reference. - * - * Added in Saleor 3.9. + * 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 */ - swatch?: InputMaybe; - /** The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created. This field will be removed in Saleor 4.0. */ values?: InputMaybe>; }; @@ -2740,15 +3111,9 @@ export type AttributeValueInput = { * 2. If externalReference is provided, then attribute value will be resolved by external reference. * 3. If value is provided, then attribute value will be resolved by value. If this attribute value doesn't exist, then it will be created. * 4. If externalReference and value is provided then new attribute value will be created. - * - * Added in Saleor 3.9. */ export type AttributeValueSelectableTypeInput = { - /** - * External reference of an attribute value. - * - * Added in Saleor 3.14. - */ + /** External reference of an attribute value. */ externalReference?: InputMaybe; /** ID of an attribute value. */ id?: InputMaybe; @@ -2759,22 +3124,14 @@ export type AttributeValueSelectableTypeInput = { /** Represents attribute value's original translatable fields and related translations. */ export type AttributeValueTranslatableContent = Node & { __typename?: 'AttributeValueTranslatableContent'; - /** - * Associated attribute that can be translated. - * - * Added in Saleor 3.9. - */ + /** Associated attribute that can be translated. */ attribute?: Maybe; /** * Represents a value of an attribute. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ attributeValue?: Maybe; - /** - * The ID of the attribute value to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the attribute value to translate. */ attributeValueId: Scalars['ID']['output']; /** The ID of the attribute value translatable content. */ id: Scalars['ID']['output']; @@ -2807,11 +3164,10 @@ export type AttributeValueTranslate = { __typename?: 'AttributeValueTranslate'; attributeValue?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; -/** An enumeration. */ export enum AttributeValueTranslateErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', @@ -2836,11 +3192,7 @@ export type AttributeValueTranslation = Node & { * Rich text format. For reference see https://editorjs.io/ */ richText?: Maybe; - /** - * Represents the attribute value fields to translate. - * - * Added in Saleor 3.14. - */ + /** Represents the attribute value fields to translate. */ translatableContent?: Maybe; }; @@ -2869,7 +3221,7 @@ export type AttributeValueUpdate = { __typename?: 'AttributeValueUpdate'; /** The updated attribute. */ attribute?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ attributeErrors: Array; attributeValue?: Maybe; errors: Array; @@ -2878,11 +3230,7 @@ export type AttributeValueUpdate = { export type AttributeValueUpdateInput = { /** File content type. */ contentType?: InputMaybe; - /** - * External ID of this attribute value. - * - * Added in Saleor 3.10. - */ + /** External ID of this attribute value. */ externalReference?: InputMaybe; /** URL of the file attribute. Every time, a new value is created. */ fileUrl?: InputMaybe; @@ -2890,27 +3238,21 @@ export type AttributeValueUpdateInput = { name?: InputMaybe; /** * Represents the text of the attribute value, plain text without formatting. - * - * DEPRECATED: this field will be removed in Saleor 4.0.The plain text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute. + * @deprecated 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: this field will be removed in Saleor 4.0.The rich text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute. + * @deprecated 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). */ value?: InputMaybe; }; -/** - * Event sent when attribute value is updated. - * - * Added in Saleor 3.5. - */ +/** Event sent when attribute value is updated. */ export type AttributeValueUpdated = Event & { __typename?: 'AttributeValueUpdated'; /** The attribute value the event relates to. */ @@ -2925,13 +3267,18 @@ export type AttributeValueUpdated = Event & { version?: Maybe; }; -/** - * Where filtering options. - * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Where filtering options for attribute values. */ +export type AttributeValueWhereInput = { + /** List of conditions that must be met. */ + AND?: InputMaybe>; + /** A list of conditions of which at least one must be met. */ + OR?: InputMaybe>; + ids?: InputMaybe>; + name?: InputMaybe; + slug?: InputMaybe; +}; + +/** Where filtering options. */ export type AttributeWhereInput = { /** List of conditions that must be met. */ AND?: InputMaybe>; @@ -2956,81 +3303,42 @@ export type AttributeWhereInput = { export type BulkAttributeValueInput = { /** The boolean value of an attribute to resolve. If the passed value is non-existent, it will be created. */ boolean?: InputMaybe; - /** - * File content type. - * - * Added in Saleor 3.12. - */ + /** File content type. */ contentType?: InputMaybe; - /** - * Represents the date value of the attribute value. - * - * Added in Saleor 3.12. - */ + /** Represents the date value of the attribute value. */ date?: InputMaybe; - /** - * Represents the date/time value of the attribute value. - * - * Added in Saleor 3.12. - */ + /** Represents the date/time value of the attribute value. */ dateTime?: InputMaybe; - /** - * Attribute value ID. - * - * Added in Saleor 3.12. - */ + /** Attribute value ID. */ dropdown?: InputMaybe; - /** - * External ID of this attribute. - * - * Added in Saleor 3.14. - */ + /** External ID of this attribute. */ externalReference?: InputMaybe; - /** - * URL of the file attribute. Every time, a new value is created. - * - * Added in Saleor 3.12. - */ + /** URL of the file attribute. Every time, a new value is created. */ file?: InputMaybe; /** ID of the selected attribute. */ id?: InputMaybe; - /** - * List of attribute value IDs. - * - * Added in Saleor 3.12. - */ + /** List of attribute value IDs. */ multiselect?: InputMaybe>; - /** - * Numeric value of an attribute. - * - * Added in Saleor 3.12. - */ + /** Numeric value of an attribute. */ numeric?: InputMaybe; - /** - * Plain text content. - * - * Added in Saleor 3.12. - */ + /** Plain text content. */ plainText?: InputMaybe; /** - * List of entity IDs that will be used as references. + * ID of the referenced entity for single reference attribute. * - * Added in Saleor 3.12. + * Added in Saleor 3.22. */ + reference?: InputMaybe; + /** List of entity IDs that will be used as references. */ references?: InputMaybe>; - /** - * Text content in JSON format. - * - * Added in Saleor 3.12. - */ + /** Text content in JSON format. */ richText?: InputMaybe; + /** Attribute value ID. */ + swatch?: InputMaybe; /** - * Attribute value ID. - * - * Added in Saleor 3.12. + * 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 */ - swatch?: InputMaybe; - /** The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.This field will be removed in Saleor 4.0. */ values?: InputMaybe>; }; @@ -3070,11 +3378,7 @@ export type BulkStockError = { values?: Maybe>; }; -/** - * Synchronous webhook for calculating checkout/order taxes. - * - * Added in Saleor 3.7. - */ +/** Synchronous webhook for calculating checkout/order taxes. */ export type CalculateTaxes = Event & { __typename?: 'CalculateTaxes'; /** Time of the event. */ @@ -3097,6 +3401,42 @@ export type CardInput = { money: MoneyInput; }; +/** + * Represents a card payment method used for a transaction. + * + * Added in Saleor 3.22. + */ +export type CardPaymentMethodDetails = PaymentMethodDetails & { + __typename?: 'CardPaymentMethodDetails'; + /** Card brand. */ + brand?: Maybe; + /** Two-digit number representing the card’s expiration month. */ + expMonth?: Maybe; + /** Four-digit number representing the card’s expiration year. */ + expYear?: Maybe; + /** First 4 digits of the card number. */ + firstDigits?: Maybe; + /** Last 4 digits of the card number. */ + lastDigits?: Maybe; + /** Name of the payment method. */ + name: Scalars['String']['output']; +}; + +export type CardPaymentMethodDetailsInput = { + /** Brand of the payment method used for the transaction. Max length is 40 characters. */ + brand?: InputMaybe; + /** Expiration month of the card used for the transaction. Value must be between 1 and 12. */ + expMonth?: InputMaybe; + /** Expiration year of the card used for the transaction. Value must be between 2000 and 9999. */ + expYear?: InputMaybe; + /** First digits of the card used for the transaction. Max length is 4 characters. */ + firstDigits?: InputMaybe; + /** Last digits of the card used for the transaction. Max length is 4 characters. */ + lastDigits?: InputMaybe; + /** Name of the payment method used for the transaction. Max length is 256 characters. */ + name: Scalars['String']['input']; +}; + export type CatalogueInput = { /** Categories related to the discount. */ categories?: InputMaybe>; @@ -3104,11 +3444,7 @@ export type CatalogueInput = { collections?: InputMaybe>; /** Products related to the discount. */ products?: InputMaybe>; - /** - * Product variant related to the discount. - * - * Added in Saleor 3.1. - */ + /** Product variant related to the discount. */ variants?: InputMaybe>; }; @@ -3146,7 +3482,7 @@ export type Category = Node & ObjectWithMetadata & { * Description of the category. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `description` field instead. + * @deprecated Use the `description` field instead. */ descriptionJson?: Maybe; /** The ID of the category. */ @@ -3159,15 +3495,9 @@ export type Category = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Name of category */ name: Scalars['String']['output']; @@ -3179,15 +3509,9 @@ export type Category = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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 products in the category. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. */ products?: Maybe; @@ -3199,11 +3523,7 @@ export type Category = Node & ObjectWithMetadata & { slug: Scalars['String']['output']; /** Returns translated category fields for the given language code. */ translation?: Maybe; - /** - * The date and time when the category was last updated. - * - * Added in Saleor 3.17. - */ + /** The date and time when the category was last updated. */ updatedAt: Scalars['DateTime']['output']; }; @@ -3265,6 +3585,7 @@ export type CategoryProductsArgs = { filter?: InputMaybe; first?: InputMaybe; last?: InputMaybe; + search?: InputMaybe; sortBy?: InputMaybe; where?: InputMaybe; }; @@ -3285,7 +3606,7 @@ export type CategoryBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -3315,15 +3636,11 @@ export type CategoryCreate = { __typename?: 'CategoryCreate'; category?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; -/** - * Event sent when new category is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new category is created. */ export type CategoryCreated = Event & { __typename?: 'CategoryCreated'; /** The category the event relates to. */ @@ -3347,15 +3664,11 @@ export type CategoryDelete = { __typename?: 'CategoryDelete'; category?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; -/** - * Event sent when category is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when category is deleted. */ export type CategoryDeleted = Event & { __typename?: 'CategoryDeleted'; /** The category the event relates to. */ @@ -3375,11 +3688,7 @@ export type CategoryFilterInput = { metadata?: InputMaybe>; search?: InputMaybe; slugs?: InputMaybe>; - /** - * Filter by when was the most recent update. - * - * Added in Saleor 3.17. - */ + /** Filter by when was the most recent update. */ updatedAt?: InputMaybe; }; @@ -3395,17 +3704,17 @@ export type CategoryInput = { */ description?: InputMaybe; /** - * Fields required to update the category metadata. + * Fields required to update the category metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Category name. */ name?: InputMaybe; /** - * Fields required to update the category private metadata. + * Fields required to update the category private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** Search engine optimization fields. */ @@ -3426,8 +3735,7 @@ export enum CategorySortField { export type CategorySortingInput = { /** * Specifies the channel in which to sort the data. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. + * @deprecated Use root-level channel argument instead. */ channel?: InputMaybe; /** Specifies the direction in which to sort categories. */ @@ -3441,14 +3749,10 @@ export type CategoryTranslatableContent = Node & { __typename?: 'CategoryTranslatableContent'; /** * Represents a single category of products. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ category?: Maybe; - /** - * The ID of the category to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the category to translate. */ categoryId: Scalars['ID']['output']; /** * Category description to translate. @@ -3460,7 +3764,7 @@ export type CategoryTranslatableContent = Node & { * Description of the category. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `description` field instead. + * @deprecated Use the `description` field instead. */ descriptionJson?: Maybe; /** The ID of the category translatable content. */ @@ -3471,6 +3775,12 @@ export type CategoryTranslatableContent = Node & { seoDescription?: Maybe; /** SEO title to translate. */ seoTitle?: Maybe; + /** + * Slug to translate. + * + * Added in Saleor 3.21. + */ + slug?: Maybe; /** Returns translated category fields for the given language code. */ translation?: Maybe; }; @@ -3490,7 +3800,7 @@ export type CategoryTranslate = { __typename?: 'CategoryTranslate'; category?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; @@ -3507,7 +3817,7 @@ export type CategoryTranslation = Node & { * Translated description of the category. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `description` field instead. + * @deprecated Use the `description` field instead. */ descriptionJson?: Maybe; /** The ID of the category translation. */ @@ -3521,10 +3831,12 @@ export type CategoryTranslation = Node & { /** Translated SEO title. */ seoTitle?: Maybe; /** - * Represents the category fields to translate. + * Translated category slug. * - * Added in Saleor 3.14. + * Added in Saleor 3.21. */ + slug?: Maybe; + /** Represents the category fields to translate. */ translatableContent?: Maybe; }; @@ -3537,15 +3849,11 @@ export type CategoryUpdate = { __typename?: 'CategoryUpdate'; category?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; -/** - * Event sent when category is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when category is updated. */ export type CategoryUpdated = Event & { __typename?: 'CategoryUpdated'; /** The category the event relates to. */ @@ -3572,27 +3880,15 @@ export type CategoryWhereInput = { /** Represents channel. */ export type Channel = Node & ObjectWithMetadata & { __typename?: 'Channel'; - /** - * Shipping methods that are available for the channel. - * - * Added in Saleor 3.6. - */ + /** Shipping methods that are available for the channel. */ availableShippingMethodsPerCountry?: Maybe>; /** * Channel-specific checkout settings. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_CHANNELS, MANAGE_CHECKOUTS. */ checkoutSettings: CheckoutSettings; - /** - * List of shippable countries for the channel. - * - * Added in Saleor 3.6. - */ + /** List of shippable countries for the channel. */ countries?: Maybe>; /** * A currency that is assigned to the channel. @@ -3603,8 +3899,6 @@ export type Channel = Node & ObjectWithMetadata & { /** * Default country for the channel. Default country can be used in checkout to determine the stock quantities or calculate taxes when the country was not explicitly provided. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. */ defaultCountry: CountryDisplay; @@ -3622,25 +3916,15 @@ export type Channel = Node & ObjectWithMetadata & { * Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. */ isActive: Scalars['Boolean']['output']; - /** - * List of public metadata items. Can be accessed without permissions. - * - * Added in Saleor 3.15. - */ + /** List of public metadata items. Can be accessed without permissions. */ metadata: Array; /** * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.15. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.15. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** * Name of the channel. @@ -3651,48 +3935,30 @@ export type Channel = Node & ObjectWithMetadata & { /** * Channel-specific order settings. * - * Added in Saleor 3.12. - * * Requires one of the following permissions: MANAGE_CHANNELS, MANAGE_ORDERS. */ orderSettings: OrderSettings; /** * Channel-specific payment settings. * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_CHANNELS, HANDLE_PAYMENTS. */ paymentSettings: PaymentSettings; - /** - * List of private metadata items. Requires staff permissions to access. - * - * Added in Saleor 3.15. - */ + /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; /** * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.15. */ 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. - * - * Added in Saleor 3.15. - */ + /** 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; /** Slug of the channel. */ slug: Scalars['String']['output']; /** * Define the stock setting for this channel. * - * Added in Saleor 3.7. - * * Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. */ stockSettings: StockSettings; @@ -3707,8 +3973,6 @@ export type Channel = Node & ObjectWithMetadata & { /** * List of warehouses assigned to this channel. * - * Added in Saleor 3.5. - * * Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. */ warehouses: Array; @@ -3756,13 +4020,13 @@ export type ChannelActivate = { __typename?: 'ChannelActivate'; /** Activated channel. */ channel?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ channelErrors: Array; errors: Array; }; /** - * Creates new channel. + * Creates a new channel. * * Requires one of the following permissions: MANAGE_CHANNELS. * @@ -3772,7 +4036,7 @@ export type ChannelActivate = { export type ChannelCreate = { __typename?: 'ChannelCreate'; channel?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ channelErrors: Array; errors: Array; }; @@ -3780,73 +4044,41 @@ export type ChannelCreate = { export type ChannelCreateInput = { /** List of shipping zones to assign to the channel. */ addShippingZones?: InputMaybe>; - /** - * List of warehouses to assign to the channel. - * - * Added in Saleor 3.5. - */ + /** List of warehouses to assign to the channel. */ addWarehouses?: InputMaybe>; - /** - * The channel checkout settings - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The channel checkout settings */ checkoutSettings?: InputMaybe; /** Currency of the channel. */ currencyCode: Scalars['String']['input']; - /** - * Default country for the channel. Default country can be used in checkout to determine the stock quantities or calculate taxes when the country was not explicitly provided. - * - * Added in Saleor 3.1. - */ + /** 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. */ defaultCountry: CountryCode; /** Determine if channel will be set active or not. */ isActive?: InputMaybe; /** - * Channel public metadata. + * Channel public metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.15. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Name of the channel. */ name: Scalars['String']['input']; - /** - * The channel order settings - * - * Added in Saleor 3.12. - */ + /** The channel order settings */ orderSettings?: InputMaybe; - /** - * The channel payment settings - * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The channel payment settings */ paymentSettings?: InputMaybe; /** - * Channel private metadata. + * Channel private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.15. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; - /** Slug of the channel. */ - slug: Scalars['String']['input']; - /** - * The channel stock settings. - * - * Added in Saleor 3.7. - */ + /** Slug of the channel. */ + slug: Scalars['String']['input']; + /** The channel stock settings. */ stockSettings?: InputMaybe; }; -/** - * Event sent when new channel is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new channel is created. */ export type ChannelCreated = Event & { __typename?: 'ChannelCreated'; /** The channel the event relates to. */ @@ -3873,13 +4105,13 @@ export type ChannelDeactivate = { __typename?: 'ChannelDeactivate'; /** Deactivated channel. */ channel?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ channelErrors: Array; errors: Array; }; /** - * Delete a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. + * Deletes a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. * * Requires one of the following permissions: MANAGE_CHANNELS. * @@ -3889,21 +4121,17 @@ export type ChannelDeactivate = { export type ChannelDelete = { __typename?: 'ChannelDelete'; channel?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ channelErrors: Array; errors: Array; }; export type ChannelDeleteInput = { - /** ID of channel to migrate orders from origin channel. */ + /** ID of a channel to migrate orders from the origin channel. Target channel has to have the same currency as the origin. */ channelId: Scalars['ID']['input']; }; -/** - * Event sent when channel is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when channel is deleted. */ export type ChannelDeleted = Event & { __typename?: 'ChannelDeleted'; /** The channel the event relates to. */ @@ -3932,7 +4160,6 @@ export type ChannelError = { warehouses?: Maybe>; }; -/** An enumeration. */ export enum ChannelErrorCode { AlreadyExists = 'ALREADY_EXISTS', ChannelsCurrencyMustBeTheSame = 'CHANNELS_CURRENCY_MUST_BE_THE_SAME', @@ -3954,13 +4181,11 @@ export type ChannelListingUpdateInput = { preorderThreshold?: InputMaybe; /** Price of the particular variant in channel. */ price?: InputMaybe; + /** Price of the variant before discount. */ + priorPrice?: InputMaybe; }; -/** - * Event sent when channel metadata is updated. - * - * Added in Saleor 3.15. - */ +/** Event sent when channel metadata is updated. */ export type ChannelMetadataUpdated = Event & { __typename?: 'ChannelMetadataUpdated'; /** The channel the event relates to. */ @@ -3978,8 +4203,6 @@ export type ChannelMetadataUpdated = Event & { /** * Reorder the warehouses of a channel. * - * Added in Saleor 3.7. - * * Requires one of the following permissions: MANAGE_CHANNELS. */ export type ChannelReorderWarehouses = { @@ -3989,11 +4212,7 @@ export type ChannelReorderWarehouses = { errors: Array; }; -/** - * Event sent when channel status has changed. - * - * Added in Saleor 3.2. - */ +/** Event sent when channel status has changed. */ export type ChannelStatusChanged = Event & { __typename?: 'ChannelStatusChanged'; /** The channel the event relates to. */ @@ -4023,7 +4242,7 @@ export type ChannelStatusChanged = Event & { export type ChannelUpdate = { __typename?: 'ChannelUpdate'; channel?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ channelErrors: Array; errors: Array; }; @@ -4031,79 +4250,43 @@ export type ChannelUpdate = { export type ChannelUpdateInput = { /** List of shipping zones to assign to the channel. */ addShippingZones?: InputMaybe>; - /** - * List of warehouses to assign to the channel. - * - * Added in Saleor 3.5. - */ + /** List of warehouses to assign to the channel. */ addWarehouses?: InputMaybe>; - /** - * The channel checkout settings - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The channel checkout settings */ checkoutSettings?: InputMaybe; - /** - * Default country for the channel. Default country can be used in checkout to determine the stock quantities or calculate taxes when the country was not explicitly provided. - * - * Added in Saleor 3.1. - */ + /** 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. */ defaultCountry?: InputMaybe; /** Determine if channel will be set active or not. */ isActive?: InputMaybe; /** - * Channel public metadata. + * Channel public metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.15. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Name of the channel. */ name?: InputMaybe; - /** - * The channel order settings - * - * Added in Saleor 3.12. - */ + /** The channel order settings */ orderSettings?: InputMaybe; - /** - * The channel payment settings - * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The channel payment settings */ paymentSettings?: InputMaybe; /** - * Channel private metadata. + * Channel private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.15. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** List of shipping zones to unassign from the channel. */ removeShippingZones?: InputMaybe>; - /** - * List of warehouses to unassign from the channel. - * - * Added in Saleor 3.5. - */ + /** List of warehouses to unassign from the channel. */ removeWarehouses?: InputMaybe>; /** Slug of the channel. */ slug?: InputMaybe; - /** - * The channel stock settings. - * - * Added in Saleor 3.7. - */ + /** The channel stock settings. */ stockSettings?: InputMaybe; }; -/** - * Event sent when channel is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when channel is updated. */ export type ChannelUpdated = Event & { __typename?: 'ChannelUpdated'; /** The channel the event relates to. */ @@ -4124,19 +4307,11 @@ export type Checkout = Node & ObjectWithMetadata & { /** * The authorize status of the checkout. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Triggers the following webhook events: * - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired. */ authorizeStatus: CheckoutAuthorizeStatusEnum; - /** - * Collection points that can be used for this order. - * - * Added in Saleor 3.1. - */ + /** Collection points that can be used for this order. */ availableCollectionPoints: Array; /** * List of available payment gateways. @@ -4151,7 +4326,7 @@ export type Checkout = Node & ObjectWithMetadata & { * 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. - * @deprecated This field will be removed in Saleor 4.0. Use `shippingMethods` instead. + * @deprecated Use `shippingMethods` instead. */ availableShippingMethods: Array; /** The billing address of the checkout. */ @@ -4161,10 +4336,6 @@ export type Checkout = Node & ObjectWithMetadata & { /** * The charge status of the checkout. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Triggers the following webhook events: * - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired. */ @@ -4172,9 +4343,13 @@ export type Checkout = Node & ObjectWithMetadata & { /** The date and time when the checkout was created. */ created: Scalars['DateTime']['output']; /** - * The delivery method selected for this checkout. + * The customer note for the checkout. * - * Added in Saleor 3.1. + * Added in Saleor 3.21. + */ + customerNote: Scalars['String']['output']; + /** + * 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. @@ -4185,11 +4360,7 @@ export type Checkout = Node & ObjectWithMetadata & { discount?: Maybe; /** The name of voucher assigned to the checkout. */ discountName?: Maybe; - /** - * Determines whether displayed prices should include taxes. - * - * Added in Saleor 3.9. - */ + /** Determines whether displayed prices should include taxes. */ displayGrossPrices: Scalars['Boolean']['output']; /** Email of a customer. */ email?: Maybe; @@ -4201,7 +4372,7 @@ export type Checkout = Node & ObjectWithMetadata & { isShippingRequired: Scalars['Boolean']['output']; /** Checkout language code. */ languageCode: LanguageCodeEnum; - /** @deprecated This field will be removed in Saleor 4.0. Use `updatedAt` instead. */ + /** @deprecated Use `updatedAt` instead. */ lastChange: Scalars['DateTime']['output']; /** A list of checkout lines, each containing information about an item in the checkout. */ lines: Array; @@ -4211,17 +4382,14 @@ export type Checkout = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ + metafields?: Maybe; /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. + * The note for the checkout. + * @deprecated Use `customerNote` instead. */ - metafields?: Maybe; - /** The note for the checkout. */ note: Scalars['String']['output']; /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; @@ -4229,23 +4397,11 @@ export type Checkout = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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 with the checkout. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of problems with the checkout. */ problems?: Maybe>; /** The number of items purchased. */ quantity: Scalars['Int']['output']; @@ -4257,7 +4413,7 @@ export type Checkout = Node & ObjectWithMetadata & { * 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. - * @deprecated This field will be removed in Saleor 4.0. Use `deliveryMethod` instead. + * @deprecated Use `deliveryMethod` instead. */ shippingMethod?: Maybe; /** @@ -4275,19 +4431,9 @@ export type Checkout = Node & ObjectWithMetadata & { * - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired. */ shippingPrice: TaxedMoney; - /** - * Date when oldest stock reservation for this checkout expires or null if no stock is reserved. - * - * Added in Saleor 3.1. - */ + /** Date when oldest stock reservation for this checkout expires or null if no stock is reserved. */ stockReservationExpires?: Maybe; - /** - * 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. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** 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?: Maybe>; /** * The price of the checkout before shipping, with taxes included. @@ -4296,21 +4442,13 @@ export type Checkout = Node & ObjectWithMetadata & { * - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired. */ subtotalPrice: TaxedMoney; - /** - * Returns True if checkout has to be exempt from taxes. - * - * Added in Saleor 3.8. - */ + /** Returns True if checkout has to be exempt from taxes. */ taxExemption: Scalars['Boolean']['output']; /** The checkout's token. */ token: Scalars['UUID']['output']; /** * The difference between the paid and the checkout total amount. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Triggers the following webhook events: * - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired. */ @@ -4322,21 +4460,11 @@ export type Checkout = Node & ObjectWithMetadata & { * - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired. */ totalPrice: TaxedMoney; - /** - * List of transactions for the checkout. Requires one of the following permissions: MANAGE_CHECKOUTS, HANDLE_PAYMENTS. - * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of transactions for the checkout. Requires one of the following permissions: MANAGE_CHECKOUTS, HANDLE_PAYMENTS. */ transactions?: Maybe>; /** 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?: Maybe; - /** - * Time of last modification of the given checkout. - * - * Added in Saleor 3.13. - */ + /** Time of last modification of the given checkout. */ updatedAt: Scalars['DateTime']['output']; /** The user assigned to the checkout. Requires one of the following permissions: MANAGE_USERS, HANDLE_PAYMENTS, OWNER. */ user?: Maybe; @@ -4392,7 +4520,7 @@ export type CheckoutAddPromoCode = { __typename?: 'CheckoutAddPromoCode'; /** The checkout with the added gift card or voucher. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; @@ -4426,8 +4554,17 @@ export enum CheckoutAuthorizeStatusEnum { Partial = 'PARTIAL' } +export type CheckoutAutoCompleteInput = { + /** Specifies the earliest date on which fully paid checkouts can begin to be automatically completed. Fully paid checkouts dated before this cut-off will not be automatically completed. Must be less than the threshold of the oldest modified checkout eligible for automatic completion. Default is current date time. */ + cutOffDate?: InputMaybe; + /** The time in minutes after which the fully paid checkout will be automatically completed. Default is 30. Set to 0 for immediate completion. Should be less than the threshold for the oldest modified checkout eligible for automatic completion. */ + delay?: InputMaybe; + /** 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. */ + enabled: Scalars['Boolean']['input']; +}; + /** - * Update billing address in the existing checkout. + * Updates billing address in the existing checkout. * * Triggers the following webhook events: * - CHECKOUT_UPDATED (async): A checkout was updated. @@ -4436,7 +4573,7 @@ export type CheckoutBillingAddressUpdate = { __typename?: 'CheckoutBillingAddressUpdate'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; @@ -4481,7 +4618,7 @@ export enum CheckoutChargeStatusEnum { */ export type CheckoutComplete = { __typename?: 'CheckoutComplete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; /** Confirmation data used to process additional authorization steps. */ confirmationData?: Maybe; @@ -4520,23 +4657,17 @@ export type CheckoutCountableEdge = { export type CheckoutCreate = { __typename?: 'CheckoutCreate'; checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; /** * 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. - * @deprecated This field will be removed in Saleor 4.0. Always returns `true`. + * @deprecated Always returns `true`. */ created?: Maybe; errors: Array; }; -/** - * Create new checkout from existing order. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Creates a new checkout from existing order. */ export type CheckoutCreateFromOrder = { __typename?: 'CheckoutCreateFromOrder'; /** Created checkout. */ @@ -4556,7 +4687,6 @@ export type CheckoutCreateFromOrderError = { message?: Maybe; }; -/** An enumeration. */ export enum CheckoutCreateFromOrderErrorCode { ChannelInactive = 'CHANNEL_INACTIVE', GraphqlError = 'GRAPHQL_ERROR', @@ -4577,7 +4707,6 @@ export type CheckoutCreateFromOrderUnavailableVariant = { variantId: Scalars['ID']['output']; }; -/** An enumeration. */ export enum CheckoutCreateFromOrderUnavailableVariantErrorCode { InsufficientStock = 'INSUFFICIENT_STOCK', NotFound = 'NOT_FOUND', @@ -4598,21 +4727,43 @@ export type CheckoutCreateInput = { languageCode?: InputMaybe; /** A list of checkout lines, each containing information about an item in the checkout. */ lines: Array; - /** The mailing address to where the checkout will be shipped. Note: the address will be ignored if the checkout doesn't contain shippable items. `skipValidation` requires HANDLE_CHECKOUTS and AUTHENTICATED_APP permissions. */ - shippingAddress?: InputMaybe; /** - * The checkout validation rules that can be changed. + * Checkout public metadata. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + * + * Added in Saleor 3.21. + */ + metadata?: InputMaybe>; + /** + * Checkout private metadata. Requires one of the following permissions: MANAGE_CHECKOUTS, HANDLE_CHECKOUTS + * + * Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + * + * Added in Saleor 3.21. + */ + privateMetadata?: InputMaybe>; + /** + * Indicates whether the billing address should be saved to the user’s address book upon checkout completion. Can only be set when a billing address is provided. If not specified along with the address, the default behavior is to save the address. + * + * Added in Saleor 3.21. + */ + saveBillingAddress?: InputMaybe; + /** + * Indicates whether the shipping address should be saved to the user’s address book upon checkout completion.Can only be set when a shipping address is provided. If not specified along with the address, the default behavior is to save the address. * - * Added in Saleor 3.5. + * Added in Saleor 3.21. */ + saveShippingAddress?: InputMaybe; + /** The mailing address to where the checkout will be shipped. Note: the address will be ignored if the checkout doesn't contain shippable items. `skipValidation` requires HANDLE_CHECKOUTS and AUTHENTICATED_APP permissions. */ + shippingAddress?: InputMaybe; + /** The checkout validation rules that can be changed. */ validationRules?: InputMaybe; }; -/** - * Event sent when new checkout is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new checkout is created. */ export type CheckoutCreated = Event & { __typename?: 'CheckoutCreated'; /** The checkout the event relates to. */ @@ -4639,7 +4790,7 @@ export type CheckoutCustomerAttach = { __typename?: 'CheckoutCustomerAttach'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; @@ -4656,15 +4807,30 @@ export type CheckoutCustomerDetach = { __typename?: 'CheckoutCustomerDetach'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; /** - * 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. + * Updates customer note in the existing checkout object. * - * Added in Saleor 3.1. + * Added in Saleor 3.21. + * + * Triggers the following webhook events: + * - CHECKOUT_UPDATED (async): A checkout was updated. + */ +export type CheckoutCustomerNoteUpdate = { + __typename?: 'CheckoutCustomerNoteUpdate'; + /** An updated checkout. */ + checkout?: Maybe; + /** @deprecated Use `errors` field instead. */ + checkoutErrors: Array; + errors: Array; +}; + +/** + * 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. * * Triggers the following webhook events: * - SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Triggered when updating the checkout delivery method with the external one. @@ -4687,7 +4853,7 @@ export type CheckoutEmailUpdate = { __typename?: 'CheckoutEmailUpdate'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; @@ -4708,7 +4874,6 @@ export type CheckoutError = { variants?: Maybe>; }; -/** An enumeration. */ export enum CheckoutErrorCode { BillingAddressNotSet = 'BILLING_ADDRESS_NOT_SET', ChannelInactive = 'CHANNEL_INACTIVE', @@ -4721,6 +4886,7 @@ export enum CheckoutErrorCode { InsufficientStock = 'INSUFFICIENT_STOCK', Invalid = 'INVALID', InvalidShippingMethod = 'INVALID_SHIPPING_METHOD', + MissingAddressData = 'MISSING_ADDRESS_DATA', MissingChannelSlug = 'MISSING_CHANNEL_SLUG', NonEditableGiftLine = 'NON_EDITABLE_GIFT_LINE', NonRemovableGiftLine = 'NON_REMOVABLE_GIFT_LINE', @@ -4754,11 +4920,7 @@ export type CheckoutFilterInput = { updatedAt?: InputMaybe; }; -/** - * Filter shipping methods for checkout. - * - * Added in Saleor 3.6. - */ +/** Filter shipping methods for checkout. */ export type CheckoutFilterShippingMethods = Event & { __typename?: 'CheckoutFilterShippingMethods'; /** The checkout the event relates to. */ @@ -4769,22 +4931,35 @@ export type CheckoutFilterShippingMethods = Event & { issuingPrincipal?: Maybe; /** The application receiving the webhook. */ recipient?: Maybe; - /** - * Shipping methods that can be used with this checkout. - * - * Added in Saleor 3.6. - */ + /** Shipping methods that can be used with this checkout. */ shippingMethods?: Maybe>; /** Saleor version that triggered the event. */ version?: Maybe; }; /** - * Event sent when checkout is fully paid with transactions. + * Event sent when a checkout was fully authorized. A checkout is considered fully authorized when its `authorizeStatus` is `FULL`. * - * Added in Saleor 3.13. + * It is triggered only for checkouts whose payments are processed through the Transaction API. + */ +export type CheckoutFullyAuthorized = Event & { + __typename?: 'CheckoutFullyAuthorized'; + /** The checkout the event relates to. */ + checkout?: Maybe; + /** Time of the event. */ + issuedAt?: Maybe; + /** The user or application that triggered the event. */ + issuingPrincipal?: Maybe; + /** The application receiving the webhook. */ + recipient?: Maybe; + /** Saleor version that triggered the event. */ + version?: Maybe; +}; + +/** + * Event sent when a checkout was fully paid. A checkout is considered fully paid when its `chargeStatus` is `FULL` or `OVERCHARGED`. This event is not sent if payments are only authorized but not fully charged. * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * It is triggered only for checkouts whose payments are processed through the Transaction API. */ export type CheckoutFullyPaid = Event & { __typename?: 'CheckoutFullyPaid'; @@ -4801,7 +4976,7 @@ export type CheckoutFullyPaid = Event & { }; /** - * Update language code in the existing checkout. + * Updates language code in the existing checkout. * * Triggers the following webhook events: * - CHECKOUT_UPDATED (async): A checkout was updated. @@ -4810,7 +4985,7 @@ export type CheckoutLanguageCodeUpdate = { __typename?: 'CheckoutLanguageCodeUpdate'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; @@ -4828,53 +5003,39 @@ export type CheckoutLine = Node & ObjectWithMetadata & { * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ isGift?: Maybe; - /** - * List of public metadata items. Can be accessed without permissions. - * - * Added in Saleor 3.5. - */ + /** List of public metadata items. Can be accessed without permissions. */ metadata: Array; /** * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.5. */ metafield?: Maybe; + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ + metafields?: Maybe; /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. + * The sum of the checkout line price prior to promotion. * - * Added in Saleor 3.5. + * Added in Saleor 3.21. */ - metafields?: Maybe; + priorTotalPrice?: Maybe; /** - * List of private metadata items. Requires staff permissions to access. + * The unit price of the checkout line prior to promotion. * - * Added in Saleor 3.5. + * Added in Saleor 3.21. */ + priorUnitPrice?: Maybe; + /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; /** * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.5. */ 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. - * - * Added in Saleor 3.5. - */ + /** 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 with the checkout line. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of problems with the checkout line. */ problems?: Maybe>; /** The quantity of product variant assigned to the checkout line. */ quantity: Scalars['Int']['output']; @@ -4953,29 +5114,21 @@ export type CheckoutLineDelete = { __typename?: 'CheckoutLineDelete'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; export type CheckoutLineInput = { - /** - * Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. - * - * Added in Saleor 3.6. - */ + /** 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. + * Fields required to update the object's metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; - /** - * Custom price of the item. Can be set only by apps with `HANDLE_CHECKOUTS` permission. When the line with the same variant will be provided multiple times, the last price will be used. - * - * Added in Saleor 3.1. - */ + /** Custom price of the item. Can be set only by apps with `HANDLE_CHECKOUTS` permission. When the line with the same variant will be provided multiple times, the last price will be used. */ price?: InputMaybe; /** The number of items purchased. */ quantity: Scalars['Int']['input']; @@ -4983,22 +5136,10 @@ export type CheckoutLineInput = { variantId: Scalars['ID']['input']; }; -/** - * Represents an problem in the checkout line. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents an problem in the checkout line. */ export type CheckoutLineProblem = CheckoutLineProblemInsufficientStock | CheckoutLineProblemVariantNotAvailable; -/** - * Indicates insufficient stock for a given checkout line.Placing the order will not be possible until solving this problem. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Indicates insufficient stock for a given checkout line.Placing the order will not be possible until solving this problem. */ export type CheckoutLineProblemInsufficientStock = { __typename?: 'CheckoutLineProblemInsufficientStock'; /** Available quantity of a variant. */ @@ -5009,13 +5150,7 @@ export type CheckoutLineProblemInsufficientStock = { variant: ProductVariant; }; -/** - * The variant assigned to the checkout line is not available.Placing the order will not be possible until solving this problem. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** The variant assigned to the checkout line is not available.Placing the order will not be possible until solving this problem. */ export type CheckoutLineProblemVariantNotAvailable = { __typename?: 'CheckoutLineProblemVariantNotAvailable'; /** The line that has variant that is not available. */ @@ -5023,24 +5158,23 @@ export type CheckoutLineProblemVariantNotAvailable = { }; export type CheckoutLineUpdateInput = { - /** - * ID of the line. - * - * Added in Saleor 3.6. - */ + /** ID of the line. */ lineId?: InputMaybe; /** - * Custom price of the item. Can be set only by apps with `HANDLE_CHECKOUTS` permission. When the line with the same variant will be provided multiple times, the last price will be used. + * Checkout line public metadata. Will add and update keys. To delete keys use deleteMetadata mutation. + * + * Added in Saleor 3.21. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.1. + * Warning: never store sensitive information, including financial data such as credit card details. */ + metadata?: InputMaybe>; + /** Custom price of the item. Can be set only by apps with `HANDLE_CHECKOUTS` permission. When the line with the same variant will be provided multiple times, the last price will be used. */ price?: InputMaybe; /** The number of items purchased. Optional for apps, required for any other users. */ quantity?: InputMaybe; /** * ID of the product variant. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `lineId` instead. + * @deprecated Use `lineId` instead. */ variantId?: InputMaybe; }; @@ -5055,7 +5189,7 @@ export type CheckoutLinesAdd = { __typename?: 'CheckoutLinesAdd'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; @@ -5083,16 +5217,12 @@ export type CheckoutLinesUpdate = { __typename?: 'CheckoutLinesUpdate'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; -/** - * Event sent when checkout metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when checkout metadata is updated. */ export type CheckoutMetadataUpdated = Event & { __typename?: 'CheckoutMetadataUpdated'; /** The checkout the event relates to. */ @@ -5107,7 +5237,7 @@ export type CheckoutMetadataUpdated = Event & { version?: Maybe; }; -/** Create a new payment for given checkout. */ +/** Creates a new payment for given checkout. */ export type CheckoutPaymentCreate = { __typename?: 'CheckoutPaymentCreate'; /** Related checkout object. */ @@ -5115,17 +5245,11 @@ export type CheckoutPaymentCreate = { errors: Array; /** A newly created payment. */ payment?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ paymentErrors: Array; }; -/** - * Represents an problem in the checkout. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents an problem in the checkout. */ export type CheckoutProblem = CheckoutLineProblemInsufficientStock | CheckoutLineProblemVariantNotAvailable; /** @@ -5138,41 +5262,59 @@ export type CheckoutRemovePromoCode = { __typename?: 'CheckoutRemovePromoCode'; /** The checkout with the removed gift card or voucher. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; -/** - * Represents the channel-specific checkout settings. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the channel-specific checkout settings. */ export type CheckoutSettings = { __typename?: '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. + * 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?: Maybe; + /** + * The time in minutes to wait after a checkout is fully paid before automatically completing it. + * + * Added in Saleor 3.22. + */ + automaticCompletionDelay?: Maybe; + /** + * 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.15.This field will be removed in Saleor 4.0. + * Added in Saleor 3.20. */ + automaticallyCompleteFullyPaidCheckouts: Scalars['Boolean']['output']; + /** 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: Scalars['Boolean']['output']; }; export type 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. + * Settings for automatic completion of fully paid checkouts. * - * Added in Saleor 3.15. + * Added in Saleor 3.22. + */ + automaticCompletion?: InputMaybe; + /** + * 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. * - * DEPRECATED: this field will be removed in Saleor 4.0. + * Added in Saleor 3.20. + * @deprecated 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 */ useLegacyErrorFlow?: InputMaybe; }; /** - * Update shipping address in the existing checkout. + * Updates shipping address in the existing checkout. * * Triggers the following webhook events: * - CHECKOUT_UPDATED (async): A checkout was updated. @@ -5181,7 +5323,7 @@ export type CheckoutShippingAddressUpdate = { __typename?: 'CheckoutShippingAddressUpdate'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; @@ -5197,7 +5339,7 @@ export type CheckoutShippingMethodUpdate = { __typename?: 'CheckoutShippingMethodUpdate'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; @@ -5218,11 +5360,7 @@ export type CheckoutSortingInput = { field: CheckoutSortField; }; -/** - * Event sent when checkout is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when checkout is updated. */ export type CheckoutUpdated = Event & { __typename?: 'CheckoutUpdated'; /** The checkout the event relates to. */ @@ -5252,6 +5390,16 @@ export type ChoiceValue = { verbose?: Maybe; }; +/** Enum determining the state of a circuit breaker. */ +export enum CircuitBreakerStateEnum { + /** The breaker is conducting (requests are passing through). */ + Closed = 'CLOSED', + /** 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. */ + HalfOpen = 'HALF_OPEN', + /** The breaker is tripped (no requests are passing). Breaker will enter half-open state after cooldown period. */ + Open = 'OPEN' +} + /** Represents a collection of products. */ export type Collection = Node & ObjectWithMetadata & { __typename?: 'Collection'; @@ -5275,7 +5423,7 @@ export type Collection = Node & ObjectWithMetadata & { * Description of the collection. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `description` field instead. + * @deprecated Use the `description` field instead. */ descriptionJson?: Maybe; /** The ID of the collection. */ @@ -5286,15 +5434,9 @@ export type Collection = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Name of the collection. */ name: Scalars['String']['output']; @@ -5304,15 +5446,9 @@ export type Collection = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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 products in this collection. */ products?: Maybe; @@ -5365,6 +5501,7 @@ export type CollectionProductsArgs = { filter?: InputMaybe; first?: InputMaybe; last?: InputMaybe; + search?: InputMaybe; sortBy?: InputMaybe; where?: InputMaybe; }; @@ -5384,7 +5521,7 @@ export type CollectionAddProducts = { __typename?: 'CollectionAddProducts'; /** Collection to which products will be added. */ collection?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ collectionErrors: Array; errors: Array; }; @@ -5396,7 +5533,7 @@ export type CollectionAddProducts = { */ export type CollectionBulkDelete = { __typename?: 'CollectionBulkDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ collectionErrors: Array; /** Returns how many objects were affected. */ count: Scalars['Int']['output']; @@ -5412,13 +5549,9 @@ export type CollectionChannelListing = Node & { id: Scalars['ID']['output']; /** Indicates if the collection is published in the channel. */ isPublished: Scalars['Boolean']['output']; - /** @deprecated This field will be removed in Saleor 4.0. Use the `publishedAt` field to fetch the publication date. */ + /** @deprecated Use the `publishedAt` field to fetch the publication date. */ publicationDate?: Maybe; - /** - * The collection publication date. - * - * Added in Saleor 3.3. - */ + /** The collection publication date. */ publishedAt?: Maybe; }; @@ -5447,7 +5580,7 @@ export type CollectionChannelListingUpdate = { __typename?: 'CollectionChannelListingUpdate'; /** An updated collection instance. */ collection?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ collectionChannelListingErrors: Array; errors: Array; }; @@ -5485,7 +5618,7 @@ export type CollectionCountableEdge = { export type CollectionCreate = { __typename?: 'CollectionCreate'; collection?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ collectionErrors: Array; errors: Array; }; @@ -5504,25 +5637,24 @@ export type CollectionCreateInput = { /** Informs whether a collection is published. */ isPublished?: InputMaybe; /** - * Fields required to update the collection metadata. + * Fields required to update the collection metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Name of the collection. */ name?: InputMaybe; /** - * Fields required to update the collection private metadata. + * Fields required to update the collection private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** List of products to be added to the collection. */ products?: InputMaybe>; /** * Publication date. ISO 8601 standard. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ publicationDate?: InputMaybe; /** Search engine optimization fields. */ @@ -5531,11 +5663,7 @@ export type CollectionCreateInput = { slug?: InputMaybe; }; -/** - * Event sent when new collection is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new collection is created. */ export type CollectionCreated = Event & { __typename?: 'CollectionCreated'; /** The collection the event relates to. */ @@ -5551,11 +5679,7 @@ export type CollectionCreated = Event & { }; -/** - * Event sent when new collection is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new collection is created. */ export type CollectionCreatedCollectionArgs = { channel?: InputMaybe; }; @@ -5568,16 +5692,12 @@ export type CollectionCreatedCollectionArgs = { export type CollectionDelete = { __typename?: 'CollectionDelete'; collection?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ collectionErrors: Array; errors: Array; }; -/** - * Event sent when collection is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when collection is deleted. */ export type CollectionDeleted = Event & { __typename?: 'CollectionDeleted'; /** The collection the event relates to. */ @@ -5593,11 +5713,7 @@ export type CollectionDeleted = Event & { }; -/** - * Event sent when collection is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when collection is deleted. */ export type CollectionDeletedCollectionArgs = { channel?: InputMaybe; }; @@ -5614,7 +5730,6 @@ export type CollectionError = { products?: Maybe>; }; -/** An enumeration. */ export enum CollectionErrorCode { CannotManageProductWithoutVariant = 'CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT', DuplicatedInputItem = 'DUPLICATED_INPUT_ITEM', @@ -5628,8 +5743,7 @@ export enum CollectionErrorCode { export type CollectionFilterInput = { /** * Specifies the channel by which the data should be filtered. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. + * @deprecated Use root-level channel argument instead. */ channel?: InputMaybe; ids?: InputMaybe>; @@ -5653,23 +5767,22 @@ export type CollectionInput = { /** Informs whether a collection is published. */ isPublished?: InputMaybe; /** - * Fields required to update the collection metadata. + * Fields required to update the collection metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Name of the collection. */ name?: InputMaybe; /** - * Fields required to update the collection private metadata. + * Fields required to update the collection private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** * Publication date. ISO 8601 standard. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ publicationDate?: InputMaybe; /** Search engine optimization fields. */ @@ -5678,11 +5791,7 @@ export type CollectionInput = { slug?: InputMaybe; }; -/** - * Event sent when collection metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when collection metadata is updated. */ export type CollectionMetadataUpdated = Event & { __typename?: 'CollectionMetadataUpdated'; /** The collection the event relates to. */ @@ -5698,11 +5807,7 @@ export type CollectionMetadataUpdated = Event & { }; -/** - * Event sent when collection metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when collection metadata is updated. */ export type CollectionMetadataUpdatedCollectionArgs = { channel?: InputMaybe; }; @@ -5721,7 +5826,7 @@ export type CollectionRemoveProducts = { __typename?: 'CollectionRemoveProducts'; /** Collection from which products will be removed. */ collection?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ collectionErrors: Array; errors: Array; }; @@ -5735,7 +5840,7 @@ export type CollectionReorderProducts = { __typename?: 'CollectionReorderProducts'; /** Collection from which products are reordered. */ collection?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ collectionErrors: Array; errors: Array; }; @@ -5755,10 +5860,11 @@ export enum CollectionSortField { * Sort collections by publication date. * * This option requires a channel filter to work as the values can vary between channels. + * @deprecated Use `PUBLISHED_AT` instead. */ PublicationDate = 'PUBLICATION_DATE', /** - * Sort collections by publication date. + * Sort collections by published at. * * This option requires a channel filter to work as the values can vary between channels. */ @@ -5768,8 +5874,7 @@ export enum CollectionSortField { export type CollectionSortingInput = { /** * Specifies the channel in which to sort the data. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. + * @deprecated Use root-level channel argument instead. */ channel?: InputMaybe; /** Specifies the direction in which to sort collections. */ @@ -5783,14 +5888,10 @@ export type CollectionTranslatableContent = Node & { __typename?: 'CollectionTranslatableContent'; /** * Represents a collection of products. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ collection?: Maybe; - /** - * The ID of the collection to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the collection to translate. */ collectionId: Scalars['ID']['output']; /** * Collection's description to translate. @@ -5802,7 +5903,7 @@ export type CollectionTranslatableContent = Node & { * Description of the collection. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `description` field instead. + * @deprecated Use the `description` field instead. */ descriptionJson?: Maybe; /** The ID of the collection translatable content. */ @@ -5813,6 +5914,12 @@ export type CollectionTranslatableContent = Node & { seoDescription?: Maybe; /** SEO title to translate. */ seoTitle?: Maybe; + /** + * Slug to translate + * + * Added in Saleor 3.21. + */ + slug?: Maybe; /** Returns translated collection fields for the given language code. */ translation?: Maybe; }; @@ -5832,7 +5939,7 @@ export type CollectionTranslate = { __typename?: 'CollectionTranslate'; collection?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; @@ -5849,7 +5956,7 @@ export type CollectionTranslation = Node & { * Translated description of the collection. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `description` field instead. + * @deprecated Use the `description` field instead. */ descriptionJson?: Maybe; /** The ID of the collection translation. */ @@ -5863,10 +5970,12 @@ export type CollectionTranslation = Node & { /** Translated SEO title. */ seoTitle?: Maybe; /** - * Represents the collection fields to translate. + * Translated collection slug. * - * Added in Saleor 3.14. + * Added in Saleor 3.21. */ + slug?: Maybe; + /** Represents the collection fields to translate. */ translatableContent?: Maybe; }; @@ -5878,16 +5987,12 @@ export type CollectionTranslation = Node & { export type CollectionUpdate = { __typename?: 'CollectionUpdate'; collection?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ collectionErrors: Array; errors: Array; }; -/** - * Event sent when collection is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when collection is updated. */ export type CollectionUpdated = Event & { __typename?: 'CollectionUpdated'; /** The collection the event relates to. */ @@ -5903,11 +6008,7 @@ export type CollectionUpdated = Event & { }; -/** - * Event sent when collection is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when collection is updated. */ export type CollectionUpdatedCollectionArgs = { channel?: InputMaybe; }; @@ -5943,7 +6044,6 @@ export type ConfigurationItemInput = { value?: InputMaybe; }; -/** An enumeration. */ export enum ConfigurationTypeFieldEnum { Boolean = 'BOOLEAN', Multiline = 'MULTILINE', @@ -5962,7 +6062,7 @@ export enum ConfigurationTypeFieldEnum { */ export type ConfirmAccount = { __typename?: 'ConfirmAccount'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** An activated user account. */ @@ -5981,13 +6081,21 @@ export type ConfirmAccount = { */ export type ConfirmEmailChange = { __typename?: 'ConfirmEmailChange'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** A user instance with a new email. */ user?: Maybe; }; +/** Define the filtering options for fields that can contain multiple values. */ +export type ContainsFilterInput = { + /** The field contains all of the specified values. */ + containsAll?: InputMaybe>; + /** The field contains at least one of the specified values. */ + containsAny?: InputMaybe>; +}; + /** * Represents country codes defined by the ISO 3166-1 alpha-2 standard. * @@ -6239,6 +6347,7 @@ export enum CountryCode { Vu = 'VU', Wf = 'WF', Ws = 'WS', + Xk = 'XK', Ye = 'YE', Yt = 'YT', Za = 'ZA', @@ -6246,6 +6355,16 @@ export enum CountryCode { Zw = 'ZW' } +/** Filter by country code. */ +export type CountryCodeEnumFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value not included in. */ + notOneOf?: InputMaybe>; + /** The value included in. */ + oneOf?: InputMaybe>; +}; + export type CountryDisplay = { __typename?: 'CountryDisplay'; /** Country code. */ @@ -6254,7 +6373,7 @@ export type CountryDisplay = { country: Scalars['String']['output']; /** * Country tax. - * @deprecated This field will be removed in Saleor 4.0. Always returns `null`. Use `TaxClassCountryRate` type to manage tax rates per country. + * @deprecated Always returns `null`. Use `TaxClassCountryRate` type to manage tax rates per country. */ vat?: Maybe; }; @@ -6281,7 +6400,7 @@ export type CountryRateUpdateInput = { /** Create JWT token. */ export type CreateToken = { __typename?: 'CreateToken'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; /** CSRF token required to re-generate access token. */ csrfToken?: Maybe; @@ -6318,7 +6437,7 @@ export type CreditCard = { */ export type CustomerBulkDelete = { __typename?: 'CustomerBulkDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; /** Returns how many objects were affected. */ count: Scalars['Int']['output']; @@ -6336,10 +6455,6 @@ export type CustomerBulkResult = { /** * Updates customers. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_USERS. * * Triggers the following webhook events: @@ -6365,7 +6480,6 @@ export type CustomerBulkUpdateError = { path?: Maybe; }; -/** An enumeration. */ export enum CustomerBulkUpdateErrorCode { Blank = 'BLANK', DuplicatedInputItem = 'DUPLICATED_INPUT_ITEM', @@ -6399,17 +6513,13 @@ export type CustomerBulkUpdateInput = { */ export type CustomerCreate = { __typename?: 'CustomerCreate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; user?: Maybe; }; -/** - * Event sent when new customer user is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new customer user is created. */ export type CustomerCreated = Event & { __typename?: 'CustomerCreated'; /** Time of the event. */ @@ -6434,7 +6544,7 @@ export type CustomerCreated = Event & { */ export type CustomerDelete = { __typename?: 'CustomerDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; user?: Maybe; @@ -6463,7 +6573,6 @@ export type CustomerEvent = Node & { user?: Maybe; }; -/** An enumeration. */ export enum CustomerEventsEnum { AccountActivated = 'ACCOUNT_ACTIVATED', AccountCreated = 'ACCOUNT_CREATED', @@ -6484,11 +6593,7 @@ export enum CustomerEventsEnum { export type CustomerFilterInput = { dateJoined?: InputMaybe; - /** - * Filter by ids. - * - * Added in Saleor 3.8. - */ + /** Filter by ids. */ ids?: InputMaybe>; metadata?: InputMaybe>; numberOfOrders?: InputMaybe; @@ -6504,47 +6609,35 @@ export type CustomerInput = { defaultShippingAddress?: InputMaybe; /** The unique email address of the user. */ email?: InputMaybe; - /** - * External ID of the customer. - * - * Added in Saleor 3.10. - */ + /** External ID of the customer. */ externalReference?: InputMaybe; /** Given name. */ firstName?: InputMaybe; /** User account is active. */ isActive?: InputMaybe; - /** - * User account is confirmed. - * - * Added in Saleor 3.15. - */ + /** User account is confirmed. */ isConfirmed?: InputMaybe; /** User language code. */ languageCode?: InputMaybe; /** Family name. */ lastName?: InputMaybe; /** - * Fields required to update the user metadata. + * Fields required to update the user metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** A note about the user. */ note?: InputMaybe; /** - * Fields required to update the user private metadata. + * Fields required to update the user private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; }; -/** - * Event sent when customer user metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when customer user metadata is updated. */ export type CustomerMetadataUpdated = Event & { __typename?: 'CustomerMetadataUpdated'; /** Time of the event. */ @@ -6570,17 +6663,13 @@ export type CustomerMetadataUpdated = Event & { */ export type CustomerUpdate = { __typename?: 'CustomerUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; user?: Maybe; }; -/** - * Event sent when customer user is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when customer user is updated. */ export type CustomerUpdated = Event & { __typename?: 'CustomerUpdated'; /** Time of the event. */ @@ -6595,6 +6684,34 @@ export type CustomerUpdated = Event & { version?: Maybe; }; +export type CustomerWhereInput = { + /** List of conditions that must be met. */ + AND?: InputMaybe>; + /** A list of conditions of which at least one must be met. */ + OR?: InputMaybe>; + /** Filter by addresses data associated with user. */ + addresses?: InputMaybe; + /** Filter by date joined. */ + dateJoined?: InputMaybe; + /** Filter by email address. */ + email?: InputMaybe; + /** Filter by first name. */ + firstName?: InputMaybe; + ids?: InputMaybe>; + /** Filter by whether the user is active. */ + isActive?: InputMaybe; + /** Filter by last name. */ + lastName?: InputMaybe; + /** Filter by metadata fields. */ + metadata?: InputMaybe; + /** Filter by number of orders placed by the user. */ + numberOfOrders?: InputMaybe; + /** Filter by date when orders were placed. */ + placedOrdersAt?: InputMaybe; + /** Filter by last updated date. */ + updatedAt?: InputMaybe; +}; + export type DateRangeInput = { /** Start date. */ gte?: InputMaybe; @@ -6602,13 +6719,7 @@ export type DateRangeInput = { lte?: InputMaybe; }; -/** - * Define the filtering options for date time fields. - * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Define the filtering options for date time fields. */ export type DateTimeFilterInput = { /** The value equal to. */ eq?: InputMaybe; @@ -6632,18 +6743,12 @@ export type DateTimeRangeInput = { */ export type DeactivateAllUserTokens = { __typename?: 'DeactivateAllUserTokens'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; }; -/** - * Define the filtering options for decimal fields. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Define the filtering options for decimal fields. */ export type DecimalFilterInput = { /** The value equal to. */ eq?: InputMaybe; @@ -6665,7 +6770,7 @@ export type DeleteMetadata = { __typename?: 'DeleteMetadata'; errors: Array; item?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ metadataErrors: Array; }; @@ -6674,15 +6779,11 @@ export type DeletePrivateMetadata = { __typename?: 'DeletePrivateMetadata'; errors: Array; item?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ metadataErrors: Array; }; -/** - * Represents a delivery method chosen for the checkout. `Warehouse` type is used when checkout is marked as "click and collect" and `ShippingMethod` otherwise. - * - * Added in Saleor 3.1. - */ +/** Represents a delivery method chosen for the checkout. `Warehouse` type is used when checkout is marked as "click and collect" and `ShippingMethod` otherwise. */ export type DeliveryMethod = ShippingMethod | Warehouse; /** Represents digital content associated with a product variant. */ @@ -6702,15 +6803,9 @@ export type DigitalContent = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; @@ -6718,15 +6813,9 @@ export type DigitalContent = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** Product variant assigned to digital content. */ productVariant: ProductVariant; @@ -6789,7 +6878,7 @@ export type DigitalContentCreate = { __typename?: 'DigitalContentCreate'; content?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; variant?: Maybe; }; @@ -6802,7 +6891,7 @@ export type DigitalContentCreate = { export type DigitalContentDelete = { __typename?: 'DigitalContentDelete'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; variant?: Maybe; }; @@ -6813,15 +6902,15 @@ export type DigitalContentInput = { /** Determines how many times a download link can be accessed by a customer. */ maxDownloads?: InputMaybe; /** - * Fields required to update the digital content metadata. + * Fields required to update the digital content metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** - * Fields required to update the digital content private metadata. + * Fields required to update the digital content private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** Determines for how many days a download link is active since it was generated. */ @@ -6831,7 +6920,7 @@ export type DigitalContentInput = { }; /** - * Update digital content. + * Updates digital content. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ @@ -6839,7 +6928,7 @@ export type DigitalContentUpdate = { __typename?: 'DigitalContentUpdate'; content?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; variant?: Maybe; }; @@ -6852,15 +6941,15 @@ export type DigitalContentUploadInput = { /** Determines how many times a download link can be accessed by a customer. */ maxDownloads?: InputMaybe; /** - * Fields required to update the digital content metadata. + * Fields required to update the digital content metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** - * Fields required to update the digital content private metadata. + * Fields required to update the digital content private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** Determines for how many days a download link is active since it was generated. */ @@ -6895,7 +6984,7 @@ export type DigitalContentUrlCreate = { __typename?: 'DigitalContentUrlCreate'; digitalContentUrl?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -6924,7 +7013,6 @@ export type DiscountError = { voucherCodes?: Maybe>; }; -/** An enumeration. */ export enum DiscountErrorCode { AlreadyExists = 'ALREADY_EXISTS', CannotManageProductWithoutVariant = 'CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT', @@ -6959,7 +7047,6 @@ export type DiscountedObjectWhereInput = { baseTotalPrice?: InputMaybe; }; -/** An enumeration. */ export enum DistanceUnitsEnum { Cm = 'CM', Dm = 'DM', @@ -6992,7 +7079,7 @@ export type DraftOrderBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -7006,7 +7093,7 @@ export type DraftOrderComplete = { errors: Array; /** Completed order. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -7019,7 +7106,7 @@ export type DraftOrderCreate = { __typename?: 'DraftOrderCreate'; errors: Array; order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -7030,18 +7117,51 @@ export type DraftOrderCreateInput = { channelId?: InputMaybe; /** A note from a customer. Visible by customers in the order summary. */ customerNote?: InputMaybe; - /** Discount amount for the order. */ + /** + * Discount amount for the order. + * @deprecated Providing a value for the field has no effect. Use `orderDiscountAdd` mutation instead. + */ discount?: InputMaybe; + /** External ID of this order. */ + externalReference?: InputMaybe; /** - * External ID of this order. + * Order language code. * - * Added in Saleor 3.10. + * Added in Saleor 3.21. */ - externalReference?: InputMaybe; + languageCode?: InputMaybe; /** Variant line input consisting of variant ID and quantity of products. */ lines?: InputMaybe>; + /** + * Order public metadata. + * + * Added in Saleor 3.21. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ + metadata?: InputMaybe>; + /** + * Order private metadata. + * + * Added in Saleor 3.21. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ + privateMetadata?: InputMaybe>; /** URL of a view where users should be redirected to see the order details. URL in RFC 1808 format. */ redirectUrl?: InputMaybe; + /** + * Indicates whether the billing address should be saved to the user’s address book upon draft order completion. Can only be set when a billing address is provided. If not specified along with the address, the default behavior is to not save the address. + * + * Added in Saleor 3.21. + */ + saveBillingAddress?: InputMaybe; + /** + * Indicates whether the shipping address should be saved to the user’s address book upon draft order completion.Can only be set when a shipping address is provided. If not specified along with the address, the default behavior is to not save the address. + * + * Added in Saleor 3.21. + */ + saveShippingAddress?: InputMaybe; /** Shipping address of the customer. */ shippingAddress?: InputMaybe; /** ID of a selected shipping method. */ @@ -7060,11 +7180,7 @@ export type DraftOrderCreateInput = { voucherCode?: InputMaybe; }; -/** - * Event sent when new draft order is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new draft order is created. */ export type DraftOrderCreated = Event & { __typename?: 'DraftOrderCreated'; /** Time of the event. */ @@ -7088,15 +7204,11 @@ export type DraftOrderDelete = { __typename?: 'DraftOrderDelete'; errors: Array; order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; -/** - * Event sent when draft order is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when draft order is deleted. */ export type DraftOrderDeleted = Event & { __typename?: 'DraftOrderDeleted'; /** Time of the event. */ @@ -7118,16 +7230,49 @@ export type DraftOrderInput = { channelId?: InputMaybe; /** A note from a customer. Visible by customers in the order summary. */ customerNote?: InputMaybe; - /** Discount amount for the order. */ + /** + * Discount amount for the order. + * @deprecated Providing a value for the field has no effect. Use `orderDiscountAdd` mutation instead. + */ discount?: InputMaybe; + /** External ID of this order. */ + externalReference?: InputMaybe; /** - * External ID of this order. + * Order language code. * - * Added in Saleor 3.10. + * Added in Saleor 3.21. */ - externalReference?: InputMaybe; + languageCode?: InputMaybe; + /** + * Order public metadata. + * + * Added in Saleor 3.21. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ + metadata?: InputMaybe>; + /** + * Order private metadata. + * + * Added in Saleor 3.21. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ + privateMetadata?: InputMaybe>; /** URL of a view where users should be redirected to see the order details. URL in RFC 1808 format. */ redirectUrl?: InputMaybe; + /** + * Indicates whether the billing address should be saved to the user’s address book upon draft order completion. Can only be set when a billing address is provided. If not specified along with the address, the default behavior is to not save the address. + * + * Added in Saleor 3.21. + */ + saveBillingAddress?: InputMaybe; + /** + * Indicates whether the shipping address should be saved to the user’s address book upon draft order completion.Can only be set when a shipping address is provided. If not specified along with the address, the default behavior is to not save the address. + * + * Added in Saleor 3.21. + */ + saveShippingAddress?: InputMaybe; /** Shipping address of the customer. */ shippingAddress?: InputMaybe; /** ID of a selected shipping method. */ @@ -7156,7 +7301,7 @@ export type DraftOrderLinesBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -7169,15 +7314,11 @@ export type DraftOrderUpdate = { __typename?: 'DraftOrderUpdate'; errors: Array; order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; -/** - * Event sent when draft order is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when draft order is updated. */ export type DraftOrderUpdated = Event & { __typename?: 'DraftOrderUpdated'; /** Time of the event. */ @@ -7192,6 +7333,54 @@ export type DraftOrderUpdated = Event & { version?: Maybe; }; +export type DraftOrderWhereInput = { + /** List of conditions that must be met. */ + AND?: InputMaybe>; + /** A list of conditions of which at least one must be met. */ + OR?: InputMaybe>; + /** Filter by authorize status. */ + authorizeStatus?: InputMaybe; + /** Filter by billing address of the order. */ + billingAddress?: InputMaybe; + /** Filter by channel. */ + channelId?: InputMaybe; + /** Filter by charge status. */ + chargeStatus?: InputMaybe; + /** Filter order by created at date. */ + createdAt?: InputMaybe; + /** Filter by order events. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. */ + events?: InputMaybe>; + ids?: InputMaybe>; + /** Filter by whether the order uses the click and collect delivery method. */ + isClickAndCollect?: InputMaybe; + /** Filter by line items associated with the order. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. */ + lines?: InputMaybe>; + /** Filter by number of lines in the order. */ + linesCount?: InputMaybe; + /** Filter by metadata fields. */ + metadata?: InputMaybe; + /** Filter by order number. */ + number?: InputMaybe; + /** Filter by the product type of related order lines. */ + productTypeId?: InputMaybe; + /** Filter by shipping address of the order. */ + shippingAddress?: InputMaybe; + /** Filter by total gross amount of the order. */ + totalGross?: InputMaybe; + /** Filter by total net amount of the order. */ + totalNet?: InputMaybe; + /** Filter by transaction data associated with the order. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. */ + transactions?: InputMaybe>; + /** Filter order by updated at date. */ + updatedAt?: InputMaybe; + /** Filter by user. */ + user?: InputMaybe; + /** Filter by user email. */ + userEmail?: InputMaybe; + /** Filter by voucher code used in the order. */ + voucherCode?: InputMaybe; +}; + export enum ErrorPolicyEnum { /** Save what is possible within a single row. If there are errors in an input data row, try to save it partially and skip the invalid part. */ IgnoreFailed = 'IGNORE_FAILED', @@ -7353,7 +7542,6 @@ export type ExportError = { message?: Maybe; }; -/** An enumeration. */ export enum ExportErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', @@ -7378,7 +7566,6 @@ export type ExportEvent = Node & { user?: Maybe; }; -/** An enumeration. */ export enum ExportEventsEnum { ExportedFileSent = 'EXPORTED_FILE_SENT', ExportDeleted = 'EXPORT_DELETED', @@ -7440,6 +7627,7 @@ export enum ExportFileSortField { CreatedAt = 'CREATED_AT', LastModifiedAt = 'LAST_MODIFIED_AT', Status = 'STATUS', + /** @deprecated Use `LAST_MODIFIED_AT` instead. */ UpdatedAt = 'UPDATED_AT' } @@ -7453,8 +7641,6 @@ export type ExportFileSortingInput = { /** * Export gift cards to csv file. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -7502,7 +7688,7 @@ export type ExportInfoInput = { export type ExportProducts = { __typename?: 'ExportProducts'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ exportErrors: Array; /** The newly created export file job which is responsible for export data. */ exportFile?: Maybe; @@ -7570,7 +7756,7 @@ export type ExternalAuthentication = { /** Prepare external authentication URL for user by custom plugin. */ export type ExternalAuthenticationUrl = { __typename?: 'ExternalAuthenticationUrl'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; /** The data returned by authentication plugin. */ authenticationData?: Maybe; @@ -7580,7 +7766,7 @@ export type ExternalAuthenticationUrl = { /** Logout user by custom plugin. */ export type ExternalLogout = { __typename?: 'ExternalLogout'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** The data returned by authentication plugin. */ @@ -7597,7 +7783,6 @@ export type ExternalNotificationError = { message?: Maybe; }; -/** An enumeration. */ export enum ExternalNotificationErrorCodes { ChannelInactive = 'CHANNEL_INACTIVE', InvalidModelType = 'INVALID_MODEL_TYPE', @@ -7605,11 +7790,7 @@ export enum ExternalNotificationErrorCodes { Required = 'REQUIRED' } -/** - * Trigger sending a notification with the notify plugin method. Serializes nodes provided as ids parameter and includes this data in the notification payload. - * - * Added in Saleor 3.1. - */ +/** Trigger sending a notification with the notify plugin method. Serializes nodes provided as ids parameter and includes this data in the notification payload. */ export type ExternalNotificationTrigger = { __typename?: 'ExternalNotificationTrigger'; errors: Array; @@ -7627,7 +7808,7 @@ export type ExternalNotificationTriggerInput = { /** Obtain external access tokens for user by custom plugin. */ export type ExternalObtainAccessTokens = { __typename?: 'ExternalObtainAccessTokens'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; /** CSRF token required to re-generate external access token. */ csrfToken?: Maybe; @@ -7643,7 +7824,7 @@ export type ExternalObtainAccessTokens = { /** Refresh user's access by custom plugin. */ export type ExternalRefresh = { __typename?: 'ExternalRefresh'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; /** CSRF token required to re-generate external access token. */ csrfToken?: Maybe; @@ -7659,7 +7840,7 @@ export type ExternalRefresh = { /** Verify external authentication data by plugin. */ export type ExternalVerify = { __typename?: 'ExternalVerify'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** Determine if authentication data is valid or not. */ @@ -7678,7 +7859,6 @@ export type File = { url: Scalars['String']['output']; }; -/** An enumeration. */ export enum FileTypesEnum { Csv = 'CSV', Xlsx = 'XLSX' @@ -7692,7 +7872,7 @@ export enum FileTypesEnum { export type FileUpload = { __typename?: 'FileUpload'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ uploadErrors: Array; uploadedFile?: Maybe; }; @@ -7714,15 +7894,9 @@ export type Fulfillment = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; @@ -7730,31 +7904,17 @@ export type Fulfillment = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; - /** - * Amount of refunded shipping price. - * - * Added in Saleor 3.14. - */ + /** Amount of refunded shipping price. */ shippingRefundedAmount?: Maybe; /** Status of fulfillment. */ status: FulfillmentStatus; /** User-friendly fulfillment status. */ statusDisplay?: Maybe; - /** - * Total refunded amount assigned to this fulfillment. - * - * Added in Saleor 3.14. - */ + /** Total refunded amount assigned to this fulfillment. */ totalRefundedAmount?: Maybe; /** Fulfillment tracking number. */ trackingNumber: Scalars['String']['output']; @@ -7789,8 +7949,6 @@ export type FulfillmentPrivateMetafieldsArgs = { /** * Approve existing fulfillment. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_ORDERS. * * Triggers the following webhook events: @@ -7803,15 +7961,11 @@ export type FulfillmentApprove = { fulfillment?: Maybe; /** Order which fulfillment was approved. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; -/** - * Event sent when fulfillment is approved. - * - * Added in Saleor 3.7. - */ +/** Event sent when fulfillment is approved. */ export type FulfillmentApproved = Event & { __typename?: 'FulfillmentApproved'; /** The fulfillment the event relates to. */ @@ -7820,11 +7974,7 @@ export type FulfillmentApproved = Event & { issuedAt?: Maybe; /** The user or application that triggered the event. */ issuingPrincipal?: Maybe; - /** - * If true, send a notification to the customer. - * - * Added in Saleor 3.16. - */ + /** If true, send a notification to the customer. */ notifyCustomer: Scalars['Boolean']['output']; /** The order the fulfillment belongs to. */ order?: Maybe; @@ -7846,7 +7996,7 @@ export type FulfillmentCancel = { fulfillment?: Maybe; /** Order which fulfillment was cancelled. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -7855,11 +8005,7 @@ export type FulfillmentCancelInput = { warehouseId?: InputMaybe; }; -/** - * Event sent when fulfillment is canceled. - * - * Added in Saleor 3.4. - */ +/** Event sent when fulfillment is canceled. */ export type FulfillmentCanceled = Event & { __typename?: 'FulfillmentCanceled'; /** The fulfillment the event relates to. */ @@ -7876,11 +8022,7 @@ export type FulfillmentCanceled = Event & { version?: Maybe; }; -/** - * Event sent when new fulfillment is created. - * - * Added in Saleor 3.4. - */ +/** Event sent when new fulfillment is created. */ export type FulfillmentCreated = Event & { __typename?: 'FulfillmentCreated'; /** The fulfillment the event relates to. */ @@ -7889,11 +8031,7 @@ export type FulfillmentCreated = Event & { issuedAt?: Maybe; /** The user or application that triggered the event. */ issuingPrincipal?: Maybe; - /** - * If true, the app should send a notification to the customer. - * - * Added in Saleor 3.16. - */ + /** If true, the app should send a notification to the customer. */ notifyCustomer: Scalars['Boolean']['output']; /** The order the fulfillment belongs to. */ order?: Maybe; @@ -7903,6 +8041,16 @@ export type FulfillmentCreated = Event & { version?: Maybe; }; +/** Filter input for order fulfillments data. */ +export type FulfillmentFilterInput = { + /** Filter by metadata fields. */ + metadata?: InputMaybe; + /** Filter by fulfillment status. */ + status?: InputMaybe; + /** Filter by fulfillment warehouse. */ + warehouse?: InputMaybe; +}; + /** Represents line of the fulfillment. */ export type FulfillmentLine = Node & { __typename?: 'FulfillmentLine'; @@ -7914,11 +8062,7 @@ export type FulfillmentLine = Node & { quantity: Scalars['Int']['output']; }; -/** - * Event sent when fulfillment metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when fulfillment metadata is updated. */ export type FulfillmentMetadataUpdated = Event & { __typename?: 'FulfillmentMetadataUpdated'; /** The fulfillment the event relates to. */ @@ -7947,7 +8091,7 @@ export type FulfillmentRefundProducts = { fulfillment?: Maybe; /** Order which fulfillment was refunded. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -7961,7 +8105,7 @@ export type FulfillmentReturnProducts = { errors: Array; /** Order which fulfillment was returned. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; /** A replace fulfillment. */ replaceFulfillment?: Maybe; @@ -7971,7 +8115,6 @@ export type FulfillmentReturnProducts = { returnFulfillment?: Maybe; }; -/** An enumeration. */ export enum FulfillmentStatus { Canceled = 'CANCELED', Fulfilled = 'FULFILLED', @@ -7982,11 +8125,15 @@ export enum FulfillmentStatus { WaitingForApproval = 'WAITING_FOR_APPROVAL' } -/** - * Event sent when the tracking number is updated. - * - * Added in Saleor 3.16. - */ +/** Filter by fulfillment status. */ +export type FulfillmentStatusEnumFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value included in. */ + oneOf?: InputMaybe>; +}; + +/** Event sent when the tracking number is updated. */ export type FulfillmentTrackingNumberUpdated = Event & { __typename?: 'FulfillmentTrackingNumberUpdated'; /** The fulfillment the event relates to. */ @@ -8018,7 +8165,7 @@ export type FulfillmentUpdateTracking = { fulfillment?: Maybe; /** Order for which fulfillment was updated. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -8029,6 +8176,16 @@ export type FulfillmentUpdateTrackingInput = { trackingNumber?: InputMaybe; }; +/** Filter input for fulfillment warehouses. */ +export type FulfillmentWarehouseFilterInput = { + /** Filter fulfillments by warehouse external reference. */ + externalReference?: InputMaybe; + /** Filter fulfillments by warehouse ID. */ + id?: InputMaybe; + /** Filter fulfillments by warehouse slug. */ + slug?: InputMaybe; +}; + /** Payment gateway client configuration key and value pair. */ export type GatewayConfigLine = { __typename?: 'GatewayConfigLine'; @@ -8044,16 +8201,10 @@ export type GiftCard = Node & ObjectWithMetadata & { /** * App which created the gift card. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_APPS, OWNER. */ app?: Maybe; - /** - * Slug of the channel where the gift card was bought. - * - * Added in Saleor 3.1. - */ + /** Slug of the channel where the gift card was bought. */ boughtInChannel?: Maybe; /** * 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. @@ -8063,17 +8214,11 @@ export type GiftCard = Node & ObjectWithMetadata & { code: Scalars['String']['output']; /** Date and time when gift card was created. */ created: Scalars['DateTime']['output']; - /** - * The user who bought or issued a gift card. - * - * Added in Saleor 3.1. - */ + /** The user who bought or issued a gift card. */ createdBy?: Maybe; /** * Email address of the user who bought or issued gift card. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_USERS, OWNER. */ createdByEmail?: Maybe; @@ -8082,14 +8227,12 @@ export type GiftCard = Node & ObjectWithMetadata & { displayCode: Scalars['String']['output']; /** * End date of gift card. - * @deprecated This field will be removed in Saleor 4.0. Use `expiryDate` field instead. + * @deprecated Use `expiryDate` field instead. */ endDate?: Maybe; /** * List of events associated with the gift card. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. */ events: Array; @@ -8109,15 +8252,9 @@ export type GiftCard = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; @@ -8125,52 +8262,36 @@ export type GiftCard = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; - /** - * Related gift card product. - * - * Added in Saleor 3.1. - */ + /** Related gift card product. */ product?: Maybe; /** * Start date of gift card. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ startDate?: Maybe; /** * The gift card tag. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. */ tags: Array; /** * The customer who used a gift card. - * - * Added in Saleor 3.1. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ usedBy?: Maybe; /** * Email address of the customer who used a gift card. - * - * Added in Saleor 3.1. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ usedByEmail?: Maybe; /** * The customer who bought a gift card. - * @deprecated This field will be removed in Saleor 4.0. Use `createdBy` field instead. + * @deprecated Use `createdBy` field instead. */ user?: Maybe; }; @@ -8218,15 +8339,13 @@ export type GiftCardActivate = { errors: Array; /** Activated gift card. */ giftCard?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ giftCardErrors: Array; }; /** * Adds note to the gift card. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -8249,8 +8368,6 @@ export type GiftCardAddNoteInput = { /** * Activate gift cards. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -8264,9 +8381,7 @@ export type GiftCardBulkActivate = { }; /** - * Create gift cards. - * - * Added in Saleor 3.1. + * Creates gift cards. * * Requires one of the following permissions: MANAGE_GIFT_CARD. * @@ -8299,8 +8414,6 @@ export type GiftCardBulkCreateInput = { /** * Deactivate gift cards. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -8314,9 +8427,7 @@ export type GiftCardBulkDeactivate = { }; /** - * Delete gift cards. - * - * Added in Saleor 3.1. + * Deletes gift cards. * * Requires one of the following permissions: MANAGE_GIFT_CARD. * @@ -8360,70 +8471,59 @@ export type GiftCardCreate = { __typename?: 'GiftCardCreate'; errors: Array; giftCard?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ giftCardErrors: Array; }; export type GiftCardCreateInput = { - /** - * The gift card tags to add. - * - * Added in Saleor 3.1. - */ + /** The gift card tags to add. */ addTags?: InputMaybe>; /** Balance of the gift card. */ balance: PriceInput; - /** - * Slug of a channel from which the email should be sent. - * - * Added in Saleor 3.1. - */ + /** Slug of a channel from which the email should be sent. */ channel?: InputMaybe; /** * Code to use the gift card. - * - * DEPRECATED: this field will be removed in Saleor 4.0. The code is now auto generated. + * @deprecated The code is now auto generated. */ code?: InputMaybe; /** * End date of the gift card in ISO 8601 format. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `expiryDate` from `expirySettings` instead. + * @deprecated Use `expiryDate` from `expirySettings` instead. */ endDate?: InputMaybe; - /** - * The gift card expiry date. - * - * Added in Saleor 3.1. - */ + /** The gift card expiry date. */ expiryDate?: InputMaybe; + /** Determine if gift card is active. */ + isActive: Scalars['Boolean']['input']; /** - * Determine if gift card is active. + * Gift Card public metadata. + * + * Added in Saleor 3.21. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.1. + * Warning: never store sensitive information, including financial data such as credit card details. */ - isActive: Scalars['Boolean']['input']; + metadata?: InputMaybe>; + /** The gift card note from the staff member. */ + note?: InputMaybe; /** - * The gift card note from the staff member. + * Gift Card private metadata. + * + * Added in Saleor 3.21. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.1. + * Warning: never store sensitive information, including financial data such as credit card details. */ - note?: InputMaybe; + privateMetadata?: InputMaybe>; /** * Start date of the gift card in ISO 8601 format. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ startDate?: InputMaybe; /** Email of the customer to whom gift card will be sent. */ userEmail?: InputMaybe; }; -/** - * Event sent when new gift card is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new gift card is created. */ export type GiftCardCreated = Event & { __typename?: 'GiftCardCreated'; /** The gift card the event relates to. */ @@ -8451,14 +8551,12 @@ export type GiftCardDeactivate = { errors: Array; /** Deactivated gift card. */ giftCard?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ giftCardErrors: Array; }; /** - * Delete gift card. - * - * Added in Saleor 3.1. + * Deletes gift card. * * Requires one of the following permissions: MANAGE_GIFT_CARD. * @@ -8469,15 +8567,11 @@ export type GiftCardDelete = { __typename?: 'GiftCardDelete'; errors: Array; giftCard?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ giftCardErrors: Array; }; -/** - * Event sent when gift card is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when gift card is deleted. */ export type GiftCardDeleted = Event & { __typename?: 'GiftCardDeleted'; /** The gift card the event relates to. */ @@ -8504,7 +8598,6 @@ export type GiftCardError = { tags?: Maybe>; }; -/** An enumeration. */ export enum GiftCardErrorCode { AlreadyExists = 'ALREADY_EXISTS', DuplicatedInputItem = 'DUPLICATED_INPUT_ITEM', @@ -8516,11 +8609,7 @@ export enum GiftCardErrorCode { Unique = 'UNIQUE' } -/** - * History log of the gift card. - * - * Added in Saleor 3.1. - */ +/** History log of the gift card. */ export type GiftCardEvent = Node & { __typename?: 'GiftCardEvent'; /** App that performed the action. Requires one of the following permissions: MANAGE_APPS, OWNER. */ @@ -8570,7 +8659,6 @@ export type GiftCardEventFilterInput = { type?: InputMaybe; }; -/** An enumeration. */ export enum GiftCardEventsEnum { Activated = 'ACTIVATED', BalanceReset = 'BALANCE_RESET', @@ -8586,11 +8674,7 @@ export enum GiftCardEventsEnum { UsedInOrder = 'USED_IN_ORDER' } -/** - * Event sent when gift card export is completed. - * - * Added in Saleor 3.16. - */ +/** Event sent when gift card export is completed. */ export type GiftCardExportCompleted = Event & { __typename?: 'GiftCardExportCompleted'; /** The export file for gift cards. */ @@ -8619,11 +8703,7 @@ export type GiftCardFilterInput = { usedBy?: InputMaybe>; }; -/** - * Event sent when gift card metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when gift card metadata is updated. */ export type GiftCardMetadataUpdated = Event & { __typename?: 'GiftCardMetadataUpdated'; /** The gift card the event relates to. */ @@ -8641,8 +8721,6 @@ export type GiftCardMetadataUpdated = Event & { /** * Resend a gift card. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -8664,13 +8742,7 @@ export type GiftCardResendInput = { id: Scalars['ID']['input']; }; -/** - * Event sent when gift card is e-mailed. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when gift card is e-mailed. */ export type GiftCardSent = Event & { __typename?: 'GiftCardSent'; /** Slug of a channel for which this gift card email was sent. */ @@ -8708,14 +8780,12 @@ export type GiftCardSettingsError = { message?: Maybe; }; -/** An enumeration. */ export enum GiftCardSettingsErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', Required = 'REQUIRED' } -/** An enumeration. */ export enum GiftCardSettingsExpiryTypeEnum { ExpiryPeriod = 'EXPIRY_PERIOD', NeverExpire = 'NEVER_EXPIRE' @@ -8741,11 +8811,7 @@ export type GiftCardSettingsUpdateInput = { }; export enum GiftCardSortField { - /** - * Sort gift cards by created at. - * - * Added in Saleor 3.8. - */ + /** Sort gift cards by created at. */ CreatedAt = 'CREATED_AT', /** Sort gift cards by current balance. */ CurrentBalance = 'CURRENT_BALANCE', @@ -8762,11 +8828,7 @@ export type GiftCardSortingInput = { field: GiftCardSortField; }; -/** - * Event sent when gift card status has changed. - * - * Added in Saleor 3.2. - */ +/** Event sent when gift card status has changed. */ export type GiftCardStatusChanged = Event & { __typename?: 'GiftCardStatusChanged'; /** The gift card the event relates to. */ @@ -8781,11 +8843,7 @@ export type GiftCardStatusChanged = Event & { version?: Maybe; }; -/** - * The gift card tag. - * - * Added in Saleor 3.1. - */ +/** The gift card tag. */ export type GiftCardTag = Node & { __typename?: 'GiftCardTag'; /** ID of the tag associated with a gift card. */ @@ -8827,54 +8885,48 @@ export type GiftCardUpdate = { __typename?: 'GiftCardUpdate'; errors: Array; giftCard?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ giftCardErrors: Array; }; export type GiftCardUpdateInput = { - /** - * The gift card tags to add. - * - * Added in Saleor 3.1. - */ + /** The gift card tags to add. */ addTags?: InputMaybe>; - /** - * The gift card balance amount. - * - * Added in Saleor 3.1. - */ + /** The gift card balance amount. */ balanceAmount?: InputMaybe; /** * End date of the gift card in ISO 8601 format. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `expiryDate` from `expirySettings` instead. + * @deprecated Use `expiryDate` from `expirySettings` instead. */ endDate?: InputMaybe; + /** The gift card expiry date. */ + expiryDate?: InputMaybe; /** - * The gift card expiry date. + * Gift Card public metadata. + * + * Added in Saleor 3.21. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.1. + * Warning: never store sensitive information, including financial data such as credit card details. */ - expiryDate?: InputMaybe; + metadata?: InputMaybe>; /** - * The gift card tags to remove. + * Gift Card private metadata. * - * Added in Saleor 3.1. + * Added in Saleor 3.21. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. */ + privateMetadata?: InputMaybe>; + /** The gift card tags to remove. */ removeTags?: InputMaybe>; /** * Start date of the gift card in ISO 8601 format. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ startDate?: InputMaybe; }; -/** - * Event sent when gift card is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when gift card is updated. */ export type GiftCardUpdated = Event & { __typename?: 'GiftCardUpdated'; /** The gift card the event relates to. */ @@ -8889,13 +8941,7 @@ export type GiftCardUpdated = Event & { version?: Maybe; }; -/** - * Define the filtering options for foreign key fields. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Define the filtering options for foreign key fields. */ export type GlobalIdFilterInput = { /** The value equal to. */ eq?: InputMaybe; @@ -8906,13 +8952,7 @@ export type GlobalIdFilterInput = { /** Represents permission group data. */ export type Group = Node & { __typename?: 'Group'; - /** - * List of channels the group has access to. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of channels the group has access to. */ accessibleChannels?: Maybe>; /** The ID of the group. */ id: Scalars['ID']['output']; @@ -8920,13 +8960,7 @@ export type Group = Node & { name: Scalars['String']['output']; /** List of group permissions */ permissions?: Maybe>; - /** - * Determine if the group have restricted access to channels. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Determine if the group have restricted access to channels. */ restrictedAccessToChannels: Scalars['Boolean']['output']; /** True, if the currently authenticated user has rights to manage a group. */ userCanManage: Scalars['Boolean']['output']; @@ -8955,6 +8989,11 @@ export type GroupCountableEdge = { node: Group; }; +export enum HttpMethod { + Get = 'GET', + Post = 'POST' +} + /** Thumbnail formats for icon images. */ export enum IconThumbnailFormatEnum { Original = 'ORIGINAL', @@ -8970,6 +9009,16 @@ export type Image = { url: Scalars['String']['output']; }; +/** Define the filtering options for integer fields. */ +export type IntFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value included in. */ + oneOf?: InputMaybe>; + /** The value in range. */ + range?: InputMaybe; +}; + export type IntRangeInput = { /** Value greater than or equal to. */ gte?: InputMaybe; @@ -8984,7 +9033,7 @@ export type Invoice = Job & Node & ObjectWithMetadata & { createdAt: Scalars['DateTime']['output']; /** * URL to view an invoice. - * @deprecated This field will be removed in Saleor 4.0. Use `url` field.This field will be removed in 4.0 + * @deprecated Use `url` field. */ externalUrl?: Maybe; /** The ID of the object. */ @@ -8997,23 +9046,13 @@ export type Invoice = Job & Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Invoice number. */ number?: Maybe; - /** - * Order related to the invoice. - * - * Added in Saleor 3.10. - */ + /** Order related to the invoice. */ order?: Maybe; /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; @@ -9021,21 +9060,15 @@ export type Invoice = Job & Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** Job status. */ status: JobStatusEnum; /** Date and time at which invoice was updated. */ updatedAt: Scalars['DateTime']['output']; - /** URL to view/download an invoice. This can be an internal URL if the Invoicing Plugin was used or an external URL if it has been provided. */ + /** URL to view/download an invoice. */ url?: Maybe; }; @@ -9072,23 +9105,23 @@ export type InvoiceCreate = { __typename?: 'InvoiceCreate'; errors: Array; invoice?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ invoiceErrors: Array; }; export type InvoiceCreateInput = { /** - * Fields required to update the invoice metadata. + * Fields required to update the invoice metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Invoice number. */ number: Scalars['String']['input']; /** - * Fields required to update the invoice private metadata. + * Fields required to update the invoice private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** URL of an invoice to download. */ @@ -9104,15 +9137,11 @@ export type InvoiceDelete = { __typename?: 'InvoiceDelete'; errors: Array; invoice?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ invoiceErrors: Array; }; -/** - * Event sent when invoice is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when invoice is deleted. */ export type InvoiceDeleted = Event & { __typename?: 'InvoiceDeleted'; /** The invoice the event relates to. */ @@ -9121,11 +9150,7 @@ export type InvoiceDeleted = Event & { issuedAt?: Maybe; /** The user or application that triggered the event. */ issuingPrincipal?: Maybe; - /** - * Order related to the invoice. - * - * Added in Saleor 3.10. - */ + /** Order related to the invoice. */ order?: Maybe; /** The application receiving the webhook. */ recipient?: Maybe; @@ -9143,7 +9168,6 @@ export type InvoiceError = { message?: Maybe; }; -/** An enumeration. */ export enum InvoiceErrorCode { EmailNotSet = 'EMAIL_NOT_SET', InvalidStatus = 'INVALID_STATUS', @@ -9155,6 +9179,12 @@ export enum InvoiceErrorCode { UrlNotSet = 'URL_NOT_SET' } +/** Filter input for invoices. */ +export type InvoiceFilterInput = { + /** Filter invoices by creation date. */ + createdAt?: InputMaybe; +}; + /** * Request an invoice for the order using plugin. * @@ -9167,7 +9197,7 @@ export type InvoiceRequest = { __typename?: 'InvoiceRequest'; errors: Array; invoice?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ invoiceErrors: Array; /** Order related to an invoice. */ order?: Maybe; @@ -9185,15 +9215,11 @@ export type InvoiceRequestDelete = { __typename?: 'InvoiceRequestDelete'; errors: Array; invoice?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ invoiceErrors: Array; }; -/** - * Event sent when invoice is requested. - * - * Added in Saleor 3.2. - */ +/** Event sent when invoice is requested. */ export type InvoiceRequested = Event & { __typename?: 'InvoiceRequested'; /** The invoice the event relates to. */ @@ -9202,11 +9228,7 @@ export type InvoiceRequested = Event & { issuedAt?: Maybe; /** The user or application that triggered the event. */ issuingPrincipal?: Maybe; - /** - * Order related to the invoice. - * - * Added in Saleor 3.10. - */ + /** Order related to the invoice. */ order: Order; /** The application receiving the webhook. */ recipient?: Maybe; @@ -9227,15 +9249,11 @@ export type InvoiceSendNotification = { __typename?: 'InvoiceSendNotification'; errors: Array; invoice?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ invoiceErrors: Array; }; -/** - * Event sent when invoice is sent. - * - * Added in Saleor 3.2. - */ +/** Event sent when invoice is sent. */ export type InvoiceSent = Event & { __typename?: 'InvoiceSent'; /** The invoice the event relates to. */ @@ -9244,11 +9262,7 @@ export type InvoiceSent = Event & { issuedAt?: Maybe; /** The user or application that triggered the event. */ issuingPrincipal?: Maybe; - /** - * Order related to the invoice. - * - * Added in Saleor 3.10. - */ + /** Order related to the invoice. */ order?: Maybe; /** The application receiving the webhook. */ recipient?: Maybe; @@ -9265,7 +9279,7 @@ export type InvoiceUpdate = { __typename?: 'InvoiceUpdate'; errors: Array; invoice?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ invoiceErrors: Array; }; @@ -9282,7 +9296,6 @@ export type Job = { updatedAt: Scalars['DateTime']['output']; }; -/** An enumeration. */ export enum JobStatusEnum { Deleted = 'DELETED', Failed = 'FAILED', @@ -9290,7 +9303,6 @@ export enum JobStatusEnum { Success = 'SUCCESS' } -/** An enumeration. */ export enum LanguageCodeEnum { Af = 'AF', AfNa = 'AF_NA', @@ -10104,11 +10116,15 @@ export type Limits = { warehouses?: Maybe; }; +/** Filter input for order lines data. */ +export type LinesFilterInput = { + /** Filter by metadata fields of order lines. */ + metadata?: InputMaybe; +}; + /** * List payment methods stored for the user by payment gateway. * - * Added in Saleor 3.15. - * * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ export type ListStoredPaymentMethods = Event & { @@ -10134,41 +10150,25 @@ export type Manifest = { about?: Maybe; /** App website rendered in the dashboard. */ appUrl?: Maybe; - /** - * The audience that will be included in all JWT tokens for the app. - * - * Added in Saleor 3.8. - */ + /** The audience that will be included in all JWT tokens for the app. */ audience?: Maybe; - /** - * The App's author name. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The App's author name. */ author?: Maybe; - /** - * App's brand data. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** App's brand data. */ brand?: Maybe; /** * URL to iframe with the configuration for the app. - * @deprecated This field will be removed in Saleor 4.0. Use `appUrl` instead. + * @deprecated Use `appUrl` instead. */ configurationUrl?: Maybe; /** * Description of the data privacy defined for this app. - * @deprecated This field will be removed in Saleor 4.0. Use `dataPrivacyUrl` instead. + * @deprecated Use `dataPrivacyUrl` instead. */ dataPrivacy?: Maybe; /** URL to the full privacy policy. */ dataPrivacyUrl?: Maybe; - /** List of extensions that will be mounted in Saleor's dashboard. For details, please [see the extension section.](https://docs.saleor.io/docs/3.x/developer/extending/apps/extending-dashboard-with-apps#key-concepts) */ + /** List of extensions that will be mounted in Saleor's dashboard. For details, please [see the extension section.](https://docs.saleor.io/developer/extending/apps/extending-dashboard-with-apps#key-concepts) */ extensions: Array; /** External URL to the app homepage. */ homepageUrl?: Maybe; @@ -10178,25 +10178,15 @@ export type Manifest = { name: Scalars['String']['output']; /** The array permissions required for the app. */ permissions?: Maybe>; - /** - * Determines the app's required Saleor version as semver range. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Determines the app's required Saleor version as semver range. */ requiredSaleorVersion?: Maybe; /** External URL to the page where app users can find support. */ supportUrl?: Maybe; - /** Endpoint used during process of app installation, [see installing an app.](https://docs.saleor.io/docs/3.x/developer/extending/apps/installing-apps#installing-an-app) */ + /** Endpoint used during process of app installation, [see installing an app.](https://docs.saleor.io/developer/extending/apps/installing-apps#installing-an-app) */ tokenTargetUrl?: Maybe; /** The version of the manifest for the app. */ version: Scalars['String']['output']; - /** - * List of the app's webhooks. - * - * Added in Saleor 3.5. - */ + /** List of the app's webhooks. */ webhooks: Array; }; @@ -10223,7 +10213,6 @@ export enum MarkAsPaidStrategyEnum { TransactionFlow = 'TRANSACTION_FLOW' } -/** An enumeration. */ export enum MeasurementUnitsEnum { AcreFt = 'ACRE_FT', AcreIn = 'ACRE_IN', @@ -10302,15 +10291,9 @@ export type Menu = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** The name of the menu. */ name: Scalars['String']['output']; @@ -10320,15 +10303,9 @@ export type Menu = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** Slug of the menu. */ slug: Scalars['String']['output']; @@ -10371,7 +10348,7 @@ export type MenuBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; }; @@ -10404,7 +10381,7 @@ export type MenuCreate = { __typename?: 'MenuCreate'; errors: Array; menu?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; }; @@ -10417,11 +10394,7 @@ export type MenuCreateInput = { slug?: InputMaybe; }; -/** - * Event sent when new menu is created. - * - * Added in Saleor 3.4. - */ +/** Event sent when new menu is created. */ export type MenuCreated = Event & { __typename?: 'MenuCreated'; /** Time of the event. */ @@ -10437,11 +10410,7 @@ export type MenuCreated = Event & { }; -/** - * Event sent when new menu is created. - * - * Added in Saleor 3.4. - */ +/** Event sent when new menu is created. */ export type MenuCreatedMenuArgs = { channel?: InputMaybe; }; @@ -10458,15 +10427,11 @@ export type MenuDelete = { __typename?: 'MenuDelete'; errors: Array; menu?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; }; -/** - * Event sent when menu is deleted. - * - * Added in Saleor 3.4. - */ +/** Event sent when menu is deleted. */ export type MenuDeleted = Event & { __typename?: 'MenuDeleted'; /** Time of the event. */ @@ -10482,11 +10447,7 @@ export type MenuDeleted = Event & { }; -/** - * Event sent when menu is deleted. - * - * Added in Saleor 3.4. - */ +/** Event sent when menu is deleted. */ export type MenuDeletedMenuArgs = { channel?: InputMaybe; }; @@ -10501,7 +10462,6 @@ export type MenuError = { message?: Maybe; }; -/** An enumeration. */ export enum MenuErrorCode { CannotAssignNode = 'CANNOT_ASSIGN_NODE', GraphqlError = 'GRAPHQL_ERROR', @@ -10549,15 +10509,9 @@ export type MenuItem = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** The name of the menu item. */ name: Scalars['String']['output']; @@ -10571,15 +10525,9 @@ export type MenuItem = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** Returns translated menu item fields for the given language code. */ translation?: Maybe; @@ -10630,7 +10578,7 @@ export type MenuItemBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; }; @@ -10662,7 +10610,7 @@ export type MenuItemCountableEdge = { export type MenuItemCreate = { __typename?: 'MenuItemCreate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; menuItem?: Maybe; }; @@ -10684,11 +10632,7 @@ export type MenuItemCreateInput = { url?: InputMaybe; }; -/** - * Event sent when new menu item is created. - * - * Added in Saleor 3.4. - */ +/** Event sent when new menu item is created. */ export type MenuItemCreated = Event & { __typename?: 'MenuItemCreated'; /** Time of the event. */ @@ -10704,11 +10648,7 @@ export type MenuItemCreated = Event & { }; -/** - * Event sent when new menu item is created. - * - * Added in Saleor 3.4. - */ +/** Event sent when new menu item is created. */ export type MenuItemCreatedMenuItemArgs = { channel?: InputMaybe; }; @@ -10724,16 +10664,12 @@ export type MenuItemCreatedMenuItemArgs = { export type MenuItemDelete = { __typename?: 'MenuItemDelete'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; menuItem?: Maybe; }; -/** - * Event sent when menu item is deleted. - * - * Added in Saleor 3.4. - */ +/** Event sent when menu item is deleted. */ export type MenuItemDeleted = Event & { __typename?: 'MenuItemDeleted'; /** Time of the event. */ @@ -10749,11 +10685,7 @@ export type MenuItemDeleted = Event & { }; -/** - * Event sent when menu item is deleted. - * - * Added in Saleor 3.4. - */ +/** Event sent when menu item is deleted. */ export type MenuItemDeletedMenuItemArgs = { channel?: InputMaybe; }; @@ -10789,7 +10721,7 @@ export type MenuItemMove = { errors: Array; /** Assigned menu to move within. */ menu?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; }; @@ -10816,14 +10748,10 @@ export type MenuItemTranslatableContent = Node & { id: Scalars['ID']['output']; /** * Represents a single item of the related menu. Can store categories, collection or pages. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ menuItem?: Maybe; - /** - * The ID of the menu item to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the menu item to translate. */ menuItemId: Scalars['ID']['output']; /** Name of the menu item to translate. */ name: Scalars['String']['output']; @@ -10846,7 +10774,7 @@ export type MenuItemTranslate = { __typename?: 'MenuItemTranslate'; errors: Array; menuItem?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; @@ -10859,11 +10787,7 @@ export type MenuItemTranslation = Node & { language: LanguageDisplay; /** Translated menu item name. */ name: Scalars['String']['output']; - /** - * Represents the menu item fields to translate. - * - * Added in Saleor 3.14. - */ + /** Represents the menu item fields to translate. */ translatableContent?: Maybe; }; @@ -10878,16 +10802,12 @@ export type MenuItemTranslation = Node & { export type MenuItemUpdate = { __typename?: 'MenuItemUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; menuItem?: Maybe; }; -/** - * Event sent when menu item is updated. - * - * Added in Saleor 3.4. - */ +/** Event sent when menu item is updated. */ export type MenuItemUpdated = Event & { __typename?: 'MenuItemUpdated'; /** Time of the event. */ @@ -10903,11 +10823,7 @@ export type MenuItemUpdated = Event & { }; -/** - * Event sent when menu item is updated. - * - * Added in Saleor 3.4. - */ +/** Event sent when menu item is updated. */ export type MenuItemUpdatedMenuItemArgs = { channel?: InputMaybe; }; @@ -10943,15 +10859,11 @@ export type MenuUpdate = { __typename?: 'MenuUpdate'; errors: Array; menu?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; }; -/** - * Event sent when menu is updated. - * - * Added in Saleor 3.4. - */ +/** Event sent when menu is updated. */ export type MenuUpdated = Event & { __typename?: 'MenuUpdated'; /** Time of the event. */ @@ -10967,11 +10879,7 @@ export type MenuUpdated = Event & { }; -/** - * Event sent when menu is updated. - * - * Added in Saleor 3.4. - */ +/** Event sent when menu is updated. */ export type MenuUpdatedMenuArgs = { channel?: InputMaybe; }; @@ -10986,7 +10894,6 @@ export type MetadataError = { message?: Maybe; }; -/** An enumeration. */ export enum MetadataErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', @@ -11002,6 +10909,24 @@ export type MetadataFilter = { value?: InputMaybe; }; +/** + * 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". + */ +export type MetadataFilterInput = { + /** Key to filter by. If not other fields provided - checking the existence of the key in metadata. */ + key: Scalars['String']['input']; + /** Value to filter by. */ + value?: InputMaybe; +}; + export type MetadataInput = { /** Key of a metadata item. */ key: Scalars['String']['input']; @@ -11017,6 +10942,14 @@ export type MetadataItem = { value: Scalars['String']['output']; }; +/** Define the filtering options for metadata value fields. */ +export type MetadataValueFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value included in. */ + oneOf?: InputMaybe>; +}; + /** Represents amount of money in specific currency. */ export type Money = { __typename?: 'Money'; @@ -11024,6 +10957,10 @@ export type Money = { amount: Scalars['Float']['output']; /** Currency code. */ currency: Scalars['String']['output']; + /** Number of digits after the decimal point in the currency. */ + fractionDigits: Scalars['Int']['output']; + /** Amount of money represented as an integer in the smallest currency unit. */ + fractionalAmount: Scalars['Int']['output']; }; export type MoneyInput = { @@ -11062,7 +10999,7 @@ export type Mutation = { */ accountAddressCreate?: Maybe; /** - * Delete an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER. + * Deletes an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER. * * Triggers the following webhook events: * - ADDRESS_DELETED (async): An address was deleted. @@ -11193,7 +11130,7 @@ export type Mutation = { */ appDelete?: Maybe; /** - * Delete failed installation. + * Deletes failed installation. * * Requires one of the following permissions: MANAGE_APPS. */ @@ -11206,6 +11143,14 @@ export type Mutation = { appFetchManifest?: Maybe; /** Install new app by using app manifest. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS. */ appInstall?: 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. + * + * Added in Saleor 3.21. + * + * Requires one of the following permissions: MANAGE_APPS. + */ + appReenableSyncWebhooks?: Maybe; /** * Retry failed installation of new app. * @@ -11253,10 +11198,6 @@ export type Mutation = { /** * Creates attributes. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Triggers the following webhook events: * - ATTRIBUTE_CREATED (async): An attribute was created. */ @@ -11273,20 +11214,12 @@ export type Mutation = { /** * Creates/updates translations for attributes. * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. */ attributeBulkTranslate?: Maybe; /** * Updates attributes. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Triggers the following webhook events: * - ATTRIBUTE_UPDATED (async): An attribute was updated. Optionally called when new attribute value was created or deleted. * - ATTRIBUTE_VALUE_CREATED (async): Called optionally when an attribute value was created. @@ -11345,11 +11278,7 @@ export type Mutation = { */ attributeValueBulkDelete?: Maybe; /** - * Creates/updates translations for attributes values. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Creates/updates translations for attribute values. * * Requires one of the following permissions: MANAGE_TRANSLATIONS. */ @@ -11430,7 +11359,7 @@ export type Mutation = { */ channelActivate?: Maybe; /** - * Creates new channel. + * Creates a new channel. * * Requires one of the following permissions: MANAGE_CHANNELS. * @@ -11448,7 +11377,7 @@ export type Mutation = { */ channelDeactivate?: Maybe; /** - * Delete a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. + * Deletes a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. * * Requires one of the following permissions: MANAGE_CHANNELS. * @@ -11459,8 +11388,6 @@ export type Mutation = { /** * Reorder the warehouses of a channel. * - * Added in Saleor 3.7. - * * Requires one of the following permissions: MANAGE_CHANNELS. */ channelReorderWarehouses?: Maybe; @@ -11485,7 +11412,7 @@ export type Mutation = { */ checkoutAddPromoCode?: Maybe; /** - * Update billing address in the existing checkout. + * Updates billing address in the existing checkout. * * Triggers the following webhook events: * - CHECKOUT_UPDATED (async): A checkout was updated. @@ -11516,13 +11443,7 @@ export type Mutation = { * - CHECKOUT_CREATED (async): A checkout was created. */ checkoutCreate?: Maybe; - /** - * Create new checkout from existing order. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Creates a new checkout from existing order. */ checkoutCreateFromOrder?: Maybe; /** * Sets the customer as the owner of the checkout. @@ -11543,9 +11464,16 @@ export type Mutation = { */ checkoutCustomerDetach?: Maybe; /** - * 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. + * Updates customer note in the existing checkout object. * - * Added in Saleor 3.1. + * Added in Saleor 3.21. + * + * Triggers the following webhook events: + * - CHECKOUT_UPDATED (async): A checkout was updated. + */ + checkoutCustomerNoteUpdate?: Maybe; + /** + * 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. * * Triggers the following webhook events: * - SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Triggered when updating the checkout delivery method with the external one. @@ -11560,7 +11488,7 @@ export type Mutation = { */ checkoutEmailUpdate?: Maybe; /** - * Update language code in the existing checkout. + * Updates language code in the existing checkout. * * Triggers the following webhook events: * - CHECKOUT_UPDATED (async): A checkout was updated. @@ -11571,7 +11499,7 @@ export type Mutation = { * * Triggers the following webhook events: * - CHECKOUT_UPDATED (async): A checkout was updated. - * @deprecated This field will be removed in Saleor 4.0. Use `checkoutLinesDelete` instead. + * @deprecated Use `checkoutLinesDelete` instead. */ checkoutLineDelete?: Maybe; /** @@ -11595,7 +11523,7 @@ export type Mutation = { * - CHECKOUT_UPDATED (async): A checkout was updated. */ checkoutLinesUpdate?: Maybe; - /** Create a new payment for given checkout. */ + /** Creates a new payment for given checkout. */ checkoutPaymentCreate?: Maybe; /** * Remove a gift card or a voucher from a checkout. @@ -11605,7 +11533,7 @@ export type Mutation = { */ checkoutRemovePromoCode?: Maybe; /** - * Update shipping address in the existing checkout. + * Updates shipping address in the existing checkout. * * Triggers the following webhook events: * - CHECKOUT_UPDATED (async): A checkout was updated. @@ -11617,7 +11545,7 @@ export type Mutation = { * 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. - * @deprecated This field will be removed in Saleor 4.0. Use `checkoutDeliveryMethodUpdate` instead. + * @deprecated Use `checkoutDeliveryMethodUpdate` instead. */ checkoutShippingMethodUpdate?: Maybe; /** @@ -11693,7 +11621,7 @@ export type Mutation = { */ confirmEmailChange?: Maybe; /** - * Creates new warehouse. + * Creates a new warehouse. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ @@ -11710,10 +11638,6 @@ export type Mutation = { /** * Updates customers. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_USERS. * * Triggers the following webhook events: @@ -11775,7 +11699,7 @@ export type Mutation = { */ digitalContentDelete?: Maybe; /** - * Update digital content. + * Updates digital content. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ @@ -11814,7 +11738,7 @@ export type Mutation = { * Deletes order lines. * * Requires one of the following permissions: MANAGE_ORDERS. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ draftOrderLinesBulkDelete?: Maybe; /** @@ -11832,8 +11756,6 @@ export type Mutation = { /** * Export gift cards to csv file. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -11870,9 +11792,7 @@ export type Mutation = { externalLogout?: Maybe; /** * Trigger sending a notification with the notify plugin method. Serializes nodes provided as ids parameter and includes this data in the notification payload. - * - * Added in Saleor 3.1. - * @deprecated \n\nDEPRECATED: this mutation will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ externalNotificationTrigger?: Maybe; /** Obtain external access tokens for user by custom plugin. */ @@ -11899,8 +11819,6 @@ export type Mutation = { /** * Adds note to the gift card. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -11910,8 +11828,6 @@ export type Mutation = { /** * Activate gift cards. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -11919,9 +11835,7 @@ export type Mutation = { */ giftCardBulkActivate?: Maybe; /** - * Create gift cards. - * - * Added in Saleor 3.1. + * Creates gift cards. * * Requires one of the following permissions: MANAGE_GIFT_CARD. * @@ -11933,8 +11847,6 @@ export type Mutation = { /** * Deactivate gift cards. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -11942,9 +11854,7 @@ export type Mutation = { */ giftCardBulkDeactivate?: Maybe; /** - * Delete gift cards. - * - * Added in Saleor 3.1. + * Deletes gift cards. * * Requires one of the following permissions: MANAGE_GIFT_CARD. * @@ -11972,9 +11882,7 @@ export type Mutation = { */ giftCardDeactivate?: Maybe; /** - * Delete gift card. - * - * Added in Saleor 3.1. + * Deletes gift card. * * Requires one of the following permissions: MANAGE_GIFT_CARD. * @@ -11985,8 +11893,6 @@ export type Mutation = { /** * Resend a gift card. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -12144,10 +12050,8 @@ export type Mutation = { /** * Adds note to the order. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. - * * Requires one of the following permissions: MANAGE_ORDERS. - * @deprecated This field will be removed in Saleor 4.0. Use `orderNoteAdd` instead. + * @deprecated Use `orderNoteAdd` instead. */ orderAddNote?: Maybe; /** @@ -12159,10 +12063,6 @@ export type Mutation = { /** * Creates multiple orders. * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS_IMPORT. */ orderBulkCreate?: Maybe; @@ -12187,8 +12087,6 @@ export type Mutation = { /** * Create new order from existing checkout. Requires the following permissions: AUTHENTICATED_APP and HANDLE_CHECKOUTS. * - * Added in Saleor 3.2. - * * 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. @@ -12235,8 +12133,6 @@ export type Mutation = { /** * Approve existing fulfillment. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_ORDERS. * * Triggers the following webhook events: @@ -12271,11 +12167,7 @@ export type Mutation = { */ orderFulfillmentUpdateTracking?: Maybe; /** - * Adds granted refund to the order. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Adds granted refund to the order. * * Requires one of the following permissions: MANAGE_ORDERS. */ @@ -12283,10 +12175,6 @@ export type Mutation = { /** * Updates granted refund. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ orderGrantRefundUpdate?: Maybe; @@ -12315,7 +12203,7 @@ export type Mutation = { */ orderLineUpdate?: Maybe; /** - * Create order lines for an order. + * Creates order lines for an order. * * Requires one of the following permissions: MANAGE_ORDERS. */ @@ -12329,20 +12217,12 @@ export type Mutation = { /** * Adds note to the order. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ orderNoteAdd?: Maybe; /** * Updates note of an order. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ orderNoteUpdate?: Maybe; @@ -12356,7 +12236,7 @@ export type Mutation = { * Update shop order settings across all channels. Returns `orderSettings` for the first `channel` in alphabetical order. * * Requires one of the following permissions: MANAGE_ORDERS. - * @deprecated \n\nDEPRECATED: this mutation will be removed in Saleor 4.0. Use `channelUpdate` mutation instead. + * @deprecated Use `channelUpdate` mutation instead. */ orderSettingsUpdate?: Maybe; /** @@ -12426,19 +12306,19 @@ export type Mutation = { */ pageTranslate?: Maybe; /** - * Delete page types. + * Deletes page types. * * Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. */ pageTypeBulkDelete?: Maybe; /** - * Create a new page type. + * Creates a new page type. * * Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. */ pageTypeCreate?: Maybe; /** - * Delete a page type. + * Deletes a page type. * * Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. */ @@ -12450,7 +12330,7 @@ export type Mutation = { */ pageTypeReorderAttributes?: Maybe; /** - * Update page type. + * Updates page type. * * Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. */ @@ -12475,21 +12355,11 @@ export type Mutation = { paymentCapture?: Maybe; /** Check payment balance. */ paymentCheckBalance?: Maybe; - /** - * 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. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** 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. */ paymentGatewayInitialize?: Maybe; /** * Initializes payment gateway for tokenizing payment method session. * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_USER. * * Triggers the following webhook events: @@ -12501,10 +12371,6 @@ export type Mutation = { /** * Tokenize payment method. * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_USER. * * Triggers the following webhook events: @@ -12514,10 +12380,6 @@ export type Mutation = { /** * Tokenize payment method. * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_USER. * * Triggers the following webhook events: @@ -12578,8 +12440,6 @@ export type Mutation = { /** * Update attributes assigned to product variant for given product type. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. */ productAttributeAssignmentUpdate?: Maybe; @@ -12592,10 +12452,6 @@ export type Mutation = { /** * Creates products. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_PRODUCTS. */ productBulkCreate?: Maybe; @@ -12608,10 +12464,6 @@ export type Mutation = { /** * Creates/updates translations for products. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. * * Triggers the following webhook events: @@ -12728,11 +12580,7 @@ export type Mutation = { */ productVariantBulkDelete?: Maybe; /** - * Creates/updates translations for products variants. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Creates/updates translations for product variants. * * Requires one of the following permissions: MANAGE_TRANSLATIONS. * @@ -12742,11 +12590,7 @@ export type Mutation = { */ productVariantBulkTranslate?: Maybe; /** - * Update multiple product variants. - * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Updates multiple product variants. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ @@ -12772,8 +12616,6 @@ export type Mutation = { /** * Deactivates product variant preorder. It changes all preorder allocation into regular allocation. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_PRODUCTS. */ productVariantPreorderDeactivate?: Maybe; @@ -12802,13 +12644,13 @@ export type Mutation = { */ productVariantStocksCreate?: Maybe; /** - * Delete stocks from product variant. + * Deletes stocks from product variant. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ productVariantStocksDelete?: Maybe; /** - * Update stocks for product variant. + * Updates stocks for product variant. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ @@ -12828,10 +12670,6 @@ export type Mutation = { /** * Deletes promotions. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -12841,10 +12679,6 @@ export type Mutation = { /** * Creates a new promotion. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -12855,10 +12689,6 @@ export type Mutation = { /** * Deletes a promotion. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -12868,10 +12698,6 @@ export type Mutation = { /** * Creates a new promotion rule. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -12881,10 +12707,6 @@ export type Mutation = { /** * Deletes a promotion rule. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -12894,18 +12716,12 @@ export type Mutation = { /** * Creates/updates translations for a promotion rule. * - * Added in Saleor 3.17. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. */ promotionRuleTranslate?: Maybe; /** * Updates an existing promotion rule. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -12915,18 +12731,12 @@ export type Mutation = { /** * Creates/updates translations for a promotion. * - * Added in Saleor 3.17. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. */ promotionTranslate?: Maybe; /** * Updates an existing promotion. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -12935,6 +12745,22 @@ export type Mutation = { * - PROMOTION_ENDED (async): Optionally called if promotion was ended. */ promotionUpdate?: Maybe; + /** + * 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. + * + * Added in Saleor 3.22. + * + * Requires one of the following permissions: MANAGE_SETTINGS. + */ + refundReasonReferenceClear?: Maybe; + /** + * Update refund settings across all channels. + * + * Added in Saleor 3.22. + * + * Requires one of the following permissions: MANAGE_SETTINGS. + */ + refundSettingsUpdate?: Maybe; /** * Request email change of the logged in user. * @@ -12966,82 +12792,71 @@ export type Mutation = { /** * Adds products, categories, collections to a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionRuleCreate` mutation instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: * - SALE_UPDATED (async): A sale was updated. + * @deprecated Use `promotionRuleCreate` and `promotionRuleUpdate` mutations instead. */ saleCataloguesAdd?: Maybe; /** * Removes products, categories, collections from a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionRuleUpdate` or `promotionRuleDelete` mutations instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: * - SALE_UPDATED (async): A sale was updated. + * @deprecated Use `promotionRuleUpdate` and `promotionRuleDelete` mutations instead. */ saleCataloguesRemove?: Maybe; /** * Manage sale's availability in channels. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionRuleCreate` or `promotionRuleUpdate` mutations instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. + * @deprecated Use `promotionRuleUpdate` mutation instead. */ saleChannelListingUpdate?: Maybe; /** * Creates a new sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionCreate` mutation instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: * - SALE_CREATED (async): A sale was created. + * @deprecated Use `promotionCreate` mutation instead. */ saleCreate?: Maybe; /** * Deletes a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionDelete` mutation instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: * - SALE_DELETED (async): A sale was deleted. + * @deprecated Use `promotionDelete` mutation instead. */ saleDelete?: Maybe; /** * Creates/updates translations for a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `PromotionTranslate` mutation instead. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. + * @deprecated Use `promotionTranslate` mutation instead. */ saleTranslate?: Maybe; /** * Updates a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionUpdate` mutation instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: * - SALE_UPDATED (async): A sale was updated. * - SALE_TOGGLE (async): Optionally triggered when a sale is started or stopped. + * @deprecated Use `promotionUpdate` mutation instead. */ saleUpdate?: Maybe; /** * Sends a notification confirmation. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_USER. * * Triggers the following webhook events: @@ -13132,17 +12947,15 @@ export type Mutation = { /** * Updates site domain of the shop. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `PUBLIC_URL` environment variable instead. - * * Requires one of the following permissions: MANAGE_SETTINGS. - * @deprecated \n\nDEPRECATED: this mutation will be removed in Saleor 4.0. Use `PUBLIC_URL` environment variable instead. + * @deprecated Use `PUBLIC_URL` environment variable instead. */ shopDomainUpdate?: Maybe; /** * Fetch tax rates. * * Requires one of the following permissions: MANAGE_SETTINGS. - * @deprecated \n\nDEPRECATED: this mutation will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ shopFetchTaxRates?: Maybe; /** @@ -13196,7 +13009,7 @@ export type Mutation = { */ staffNotificationRecipientCreate?: Maybe; /** - * Delete staff notification recipient. + * Deletes staff notification recipient. * * Requires one of the following permissions: MANAGE_SETTINGS. */ @@ -13219,10 +13032,6 @@ export type Mutation = { /** * 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. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_PRODUCTS. * * Triggers the following webhook events: @@ -13232,10 +13041,6 @@ export type Mutation = { /** * Request to delete a stored payment method on payment provider side. * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_USER. * * Triggers the following webhook events: @@ -13243,33 +13048,25 @@ export type Mutation = { */ storedPaymentMethodRequestDelete?: Maybe; /** - * Create a tax class. - * - * Added in Saleor 3.9. + * Creates a tax class. * * Requires one of the following permissions: MANAGE_TAXES. */ taxClassCreate?: Maybe; /** - * Delete a tax class. After deleting the tax class any products, product types or shipping methods using it are updated to use the default tax class. - * - * Added in Saleor 3.9. + * 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. * * Requires one of the following permissions: MANAGE_TAXES. */ taxClassDelete?: Maybe; /** - * Update a tax class. - * - * Added in Saleor 3.9. + * Updates a tax class. * * Requires one of the following permissions: MANAGE_TAXES. */ taxClassUpdate?: Maybe; /** - * Update tax configuration for a channel. - * - * Added in Saleor 3.9. + * Updates tax configuration for a channel. * * Requires one of the following permissions: MANAGE_TAXES. */ @@ -13277,15 +13074,11 @@ export type Mutation = { /** * Remove all tax class rates for a specific country. * - * Added in Saleor 3.9. - * * Requires one of the following permissions: MANAGE_TAXES. */ taxCountryConfigurationDelete?: Maybe; /** - * Update tax class rates for a specific country. - * - * Added in Saleor 3.9. + * Updates tax class rates for a specific country. * * Requires one of the following permissions: MANAGE_TAXES. */ @@ -13293,8 +13086,6 @@ export type Mutation = { /** * Exempt checkout or order from charging the taxes. When tax exemption is enabled, taxes won't be charged for the checkout or order. Taxes may still be calculated in cases when product prices are entered with the tax included and the net price needs to be known. * - * Added in Saleor 3.8. - * * Requires one of the following permissions: MANAGE_TAXES. */ taxExemptionManage?: Maybe; @@ -13311,11 +13102,7 @@ export type Mutation = { */ tokensDeactivateAll?: Maybe; /** - * Create transaction for checkout or order. - * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Creates transaction for checkout or order. * * Requires one of the following permissions: HANDLE_PAYMENTS. */ @@ -13323,56 +13110,33 @@ export type Mutation = { /** * Report the event for the transaction. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app. - */ - transactionEventReport?: 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. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Triggers the following webhook events: + * - TRANSACTION_ITEM_METADATA_UPDATED (async): Optionally called when transaction's metadata was updated. + * - 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. */ + 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`. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. */ transactionProcess?: Maybe; /** * Request an action for payment transaction. * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: HANDLE_PAYMENTS. */ transactionRequestAction?: Maybe; /** * Request a refund for payment transaction based on granted refund. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: HANDLE_PAYMENTS. */ transactionRequestRefundForGrantedRefund?: Maybe; /** * Update transaction. * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app. */ transactionUpdate?: Maybe; @@ -13382,9 +13146,17 @@ export type Mutation = { * Requires one of the following permissions: MANAGE_PRODUCTS. */ unassignWarehouseShippingZone?: Maybe; - /** Updates metadata of an object. To use it, you need to have access to the modified object. */ + /** + * Updates metadata of an object.Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ updateMetadata?: Maybe; - /** Updates private metadata of an object. To use it, you need to be an authenticated staff user or an app and have access to the modified object. */ + /** + * Updates private metadata of an object. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ updatePrivateMetadata?: Maybe; /** * Updates given warehouse. @@ -13511,7 +13283,7 @@ export type Mutation = { */ webhookCreate?: Maybe; /** - * Delete a webhook. Before the deletion, the webhook is deactivated to pause any deliveries that are already scheduled. The deletion might fail if delivery is in progress. In such a case, the webhook is not deleted but remains deactivated. + * 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. * * Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP. */ @@ -13519,20 +13291,12 @@ export type Mutation = { /** * Performs a dry run of a webhook event. Supports a single event (the first, if multiple provided in the `query`). Requires permission relevant to processed event. * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER. */ webhookDryRun?: Maybe; /** * Trigger a webhook event. Supports a single event (the first, if multiple provided in the `webhook.subscription_query`). Requires permission relevant to processed event. Successfully delivered webhook returns `delivery` with status='PENDING' and empty payload. * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER. */ webhookTrigger?: Maybe; @@ -13650,6 +13414,11 @@ export type MutationAppInstallArgs = { }; +export type MutationAppReenableSyncWebhooksArgs = { + appId: Scalars['ID']['input']; +}; + + export type MutationAppRetryInstallArgs = { activateAfterInstallation?: InputMaybe; id: Scalars['ID']['input']; @@ -13854,6 +13623,7 @@ export type MutationCheckoutBillingAddressUpdateArgs = { billingAddress: AddressInput; checkoutId?: InputMaybe; id?: InputMaybe; + saveAddress?: InputMaybe; token?: InputMaybe; validationRules?: InputMaybe; }; @@ -13895,6 +13665,12 @@ export type MutationCheckoutCustomerDetachArgs = { }; +export type MutationCheckoutCustomerNoteUpdateArgs = { + customerNote: Scalars['String']['input']; + id: Scalars['ID']['input']; +}; + + export type MutationCheckoutDeliveryMethodUpdateArgs = { deliveryMethodId?: InputMaybe; id?: InputMaybe; @@ -13969,6 +13745,7 @@ export type MutationCheckoutRemovePromoCodeArgs = { export type MutationCheckoutShippingAddressUpdateArgs = { checkoutId?: InputMaybe; id?: InputMaybe; + saveAddress?: InputMaybe; shippingAddress: AddressInput; token?: InputMaybe; validationRules?: InputMaybe; @@ -14998,6 +14775,11 @@ export type MutationPromotionUpdateArgs = { }; +export type MutationRefundSettingsUpdateArgs = { + input: RefundSettingsUpdateInput; +}; + + export type MutationRequestEmailChangeArgs = { channel?: InputMaybe; newEmail: Scalars['String']['input']; @@ -15274,14 +15056,17 @@ export type MutationTransactionCreateArgs = { export type MutationTransactionEventReportArgs = { - amount: Scalars['PositiveDecimal']['input']; + amount?: InputMaybe; availableActions?: InputMaybe>; externalUrl?: InputMaybe; id?: InputMaybe; message?: InputMaybe; + paymentMethodDetails?: InputMaybe; pspReference: Scalars['String']['input']; time?: InputMaybe; token?: InputMaybe; + transactionMetadata?: InputMaybe>; + transactionPrivateMetadata?: InputMaybe>; type: TransactionEventTypeEnum; }; @@ -15308,6 +15093,8 @@ export type MutationTransactionRequestActionArgs = { actionType: TransactionActionEnum; amount?: InputMaybe; id?: InputMaybe; + refundReason?: InputMaybe; + refundReasonReference?: InputMaybe; token?: InputMaybe; }; @@ -15464,12 +15251,62 @@ export enum NavigationType { Secondary = 'SECONDARY' } +/** Represents the NEW_TAB target options for an app extension. */ +export type NewTabTargetOptions = { + __typename?: 'NewTabTargetOptions'; + /** + * HTTP method for New Tab target (GET or POST) + * @deprecated Use `settings` field directly. + */ + method: HttpMethod; +}; + /** An object with an ID */ export type Node = { /** The ID of the object. */ id: Scalars['ID']['output']; }; +/** + * An object with attributes. + * + * Added in Saleor 3.22. + */ +export type ObjectWithAttributes = { + /** + * Get a single attribute attached to the object by attribute slug. + * + * Added in Saleor 3.22. + */ + assignedAttribute?: Maybe; + /** + * List of attributes assigned to the object. + * + * Added in Saleor 3.22. + */ + assignedAttributes: Array; +}; + + +/** + * An object with attributes. + * + * Added in Saleor 3.22. + */ +export type ObjectWithAttributesAssignedAttributeArgs = { + slug: Scalars['String']['input']; +}; + + +/** + * An object with attributes. + * + * Added in Saleor 3.22. + */ +export type ObjectWithAttributesAssignedAttributesArgs = { + limit?: InputMaybe; +}; + export type ObjectWithMetadata = { /** List of public metadata items. Can be accessed without permissions. */ metadata: Array; @@ -15518,17 +15355,9 @@ export type Order = Node & ObjectWithMetadata & { __typename?: 'Order'; /** List of actions that can be performed in the current state of an order. */ actions: Array; - /** - * The authorize status of the order. - * - * Added in Saleor 3.4. - */ + /** The authorize status of the order. */ authorizeStatus: OrderAuthorizeStatusEnum; - /** - * Collection points that can be used for this order. - * - * Added in Saleor 3.1. - */ + /** Collection points that can be used for this order. */ availableCollectionPoints: Array; /** * Shipping methods that can be used with this order. @@ -15541,17 +15370,9 @@ export type Order = Node & ObjectWithMetadata & { canFinalize: Scalars['Boolean']['output']; /** Channel through which the order was placed. */ channel: Channel; - /** - * The charge status of the order. - * - * Added in Saleor 3.4. - */ + /** The charge status of the order. */ chargeStatus: OrderChargeStatusEnum; - /** - * ID of the checkout that the order was created from. - * - * Added in Saleor 3.11. - */ + /** ID of the checkout that the order was created from. */ checkoutId?: Maybe; /** Name of the collection point where the order should be picked up by the customer. */ collectionPointName?: Maybe; @@ -15559,29 +15380,21 @@ export type Order = Node & ObjectWithMetadata & { created: Scalars['DateTime']['output']; /** Additional information provided by the customer about the order. */ customerNote: Scalars['String']['output']; - /** - * The delivery method selected for this order. - * - * Added in Saleor 3.1. - */ + /** The delivery method selected for this order. */ deliveryMethod?: Maybe; /** * Returns applied discount. - * @deprecated This field will be removed in Saleor 4.0. Use the `discounts` field instead. + * @deprecated Use the `discounts` field instead. */ discount?: Maybe; /** * Discount name. - * @deprecated This field will be removed in Saleor 4.0. Use the `discounts` field instead. + * @deprecated Use the `discounts` field instead. */ discountName?: Maybe; /** List of all discounts assigned to the order. */ discounts: Array; - /** - * Determines whether displayed prices should include taxes. - * - * Added in Saleor 3.9. - */ + /** Determines whether displayed prices should include taxes. */ displayGrossPrices: Scalars['Boolean']['output']; /** List of errors that occurred during order validation. */ errors: Array; @@ -15591,11 +15404,7 @@ export type Order = Node & ObjectWithMetadata & { * Requires one of the following permissions: MANAGE_ORDERS. */ events: Array; - /** - * External ID of this order. - * - * Added in Saleor 3.10. - */ + /** External ID of this order. */ externalReference?: Maybe; /** List of shipments for the order. */ fulfillments: Array; @@ -15604,10 +15413,6 @@ export type Order = Node & ObjectWithMetadata & { /** * List of granted refunds. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ grantedRefunds: Array; @@ -15619,7 +15424,7 @@ export type Order = Node & ObjectWithMetadata & { isPaid: Scalars['Boolean']['output']; /** Returns True, if order requires shipping. */ isShippingRequired: Scalars['Boolean']['output']; - /** @deprecated This field will be removed in Saleor 4.0. Use the `languageCodeEnum` field to fetch the language code. */ + /** @deprecated Use the `languageCodeEnum` field to fetch the language code. */ languageCode: Scalars['String']['output']; /** Order language code. */ languageCodeEnum: LanguageCodeEnum; @@ -15631,15 +15436,9 @@ export type Order = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** User-friendly number of an order. */ number: Scalars['String']['output']; @@ -15659,15 +15458,9 @@ export type Order = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** URL to which user should be redirected after order is placed. */ redirectUrl?: Maybe; @@ -15675,7 +15468,7 @@ export type Order = Node & ObjectWithMetadata & { shippingAddress?: Maybe
; /** * Shipping method for this order. - * @deprecated This field will be removed in Saleor 4.0. Use `deliveryMethod` instead. + * @deprecated Use `deliveryMethod` instead. */ shippingMethod?: Maybe; /** Method used for shipping. */ @@ -15687,28 +15480,14 @@ export type Order = Node & ObjectWithMetadata & { /** * Denormalized tax class assigned to the shipping method. * - * Added in Saleor 3.9. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */ shippingTaxClass?: Maybe; - /** - * Denormalized public metadata of the shipping method's tax class. - * - * Added in Saleor 3.9. - */ + /** Denormalized public metadata of the shipping method's tax class. */ shippingTaxClassMetadata: Array; - /** - * Denormalized name of the tax class assigned to the shipping method. - * - * Added in Saleor 3.9. - */ + /** Denormalized name of the tax class assigned to the shipping method. */ shippingTaxClassName?: Maybe; - /** - * Denormalized private metadata of the shipping method's tax class. Requires staff permissions to access. - * - * Added in Saleor 3.9. - */ + /** Denormalized private metadata of the shipping method's tax class. Requires staff permissions to access. */ shippingTaxClassPrivateMetadata: Array; /** The shipping tax rate value. */ shippingTaxRate: Scalars['Float']['output']; @@ -15718,23 +15497,15 @@ export type Order = Node & ObjectWithMetadata & { statusDisplay: Scalars['String']['output']; /** The sum of line prices not including shipping. */ subtotal: TaxedMoney; - /** - * Returns True if order has to be exempt from taxes. - * - * Added in Saleor 3.8. - */ + /** Returns True if order has to be exempt from taxes. */ taxExemption: Scalars['Boolean']['output']; - /** @deprecated This field will be removed in Saleor 4.0. Use `id` instead. */ + /** @deprecated Use `id` instead. */ token: Scalars['String']['output']; /** Total amount of the order. */ total: TaxedMoney; /** * Total amount of ongoing authorize requests for the order's transactions. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ totalAuthorizePending: Money; @@ -15745,89 +15516,51 @@ export type Order = Node & ObjectWithMetadata & { /** * Total amount of ongoing cancel requests for the order's transactions. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ totalCancelPending: Money; - /** - * Amount canceled for the order. - * - * Added in Saleor 3.13. - */ + /** Amount canceled for the order. */ totalCanceled: Money; /** * Amount captured for the order. - * @deprecated This field will be removed in Saleor 4.0. Use `totalCharged` instead. + * @deprecated Use `totalCharged` instead. */ totalCaptured: Money; /** * Total amount of ongoing charge requests for the order's transactions. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ totalChargePending: Money; - /** - * Amount charged for the order. - * - * Added in Saleor 3.13. - */ + /** Amount charged for the order. */ totalCharged: Money; /** * Total amount of granted refund. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ totalGrantedRefund: Money; /** * Total amount of ongoing refund requests for the order's transactions. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ totalRefundPending: Money; - /** - * Total refund amount for the order. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Total refund amount for the order. */ totalRefunded: Money; /** * The difference amount between granted refund and the amounts that are pending and refunded. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ totalRemainingGrant: Money; - /** Google Analytics tracking client ID. This field will be removed in Saleor 4.0. */ - trackingClientId: Scalars['String']['output']; - /** - * List of transactions for the order. Requires one of the following permissions: MANAGE_ORDERS, HANDLE_PAYMENTS. - * - * Added in Saleor 3.4. - */ + /** Google Analytics tracking client ID. */ + trackingClientId: Scalars['String']['output']; + /** List of transactions for the order. Requires one of the following permissions: MANAGE_ORDERS, HANDLE_PAYMENTS. */ transactions: Array; /** * Translated discount name. - * @deprecated This field will be removed in Saleor 4.0. Use the `discounts` field instead. + * @deprecated Use the `discounts` field instead. */ translatedDiscountName?: Maybe; /** @@ -15835,7 +15568,7 @@ export type Order = Node & ObjectWithMetadata & { * * Added in Saleor 3.19. */ - undiscountedShippingPrice?: Maybe; + undiscountedShippingPrice: Money; /** Undiscounted total amount of the order. */ undiscountedTotal: TaxedMoney; /** Date and time when the order was created. */ @@ -15894,8 +15627,6 @@ export enum OrderAction { /** * Adds note to the order. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. - * * Requires one of the following permissions: MANAGE_ORDERS. */ export type OrderAddNote = { @@ -15905,16 +15636,12 @@ export type OrderAddNote = { event?: Maybe; /** Order with the note added. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; export type OrderAddNoteInput = { - /** - * Note message. - * - * DEPRECATED: this field will be removed in Saleor 4.0. - */ + /** Note message. */ message: Scalars['String']['input']; }; @@ -15940,6 +15667,14 @@ export enum OrderAuthorizeStatusEnum { Partial = 'PARTIAL' } +/** Filter by authorize status. */ +export type OrderAuthorizeStatusEnumFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value included in. */ + oneOf?: InputMaybe>; +}; + /** * Cancels orders. * @@ -15950,17 +15685,13 @@ export type OrderBulkCancel = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; /** * Creates multiple orders. * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS_IMPORT. */ export type OrderBulkCreate = { @@ -15981,11 +15712,19 @@ export type OrderBulkCreateDeliveryMethodInput = { shippingPrice?: InputMaybe; /** The ID of the tax class. */ shippingTaxClassId?: InputMaybe; - /** Metadata of the tax class. */ + /** + * Metadata of the tax class. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ shippingTaxClassMetadata?: InputMaybe>; /** The name of the tax class. */ shippingTaxClassName?: InputMaybe; - /** Private metadata of the tax class. */ + /** + * Private metadata of the tax class. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ shippingTaxClassPrivateMetadata?: InputMaybe>; /** Tax rate of the shipping. */ shippingTaxRate?: InputMaybe; @@ -16005,7 +15744,6 @@ export type OrderBulkCreateError = { path?: Maybe; }; -/** An enumeration. */ export enum OrderBulkCreateErrorCode { BulkLimit = 'BULK_LIMIT', FutureDate = 'FUTURE_DATE', @@ -16078,11 +15816,19 @@ export type OrderBulkCreateInput = { languageCode: LanguageCodeEnum; /** List of order lines. */ lines: Array; - /** Metadata of the order. */ + /** + * Metadata of the order. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ metadata?: InputMaybe>; /** Notes related to the order. */ notes?: InputMaybe>; - /** Private metadata of the order. */ + /** + * Private metadata of the order. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ privateMetadata?: InputMaybe>; /** URL of a view, where users should be redirected to see the order details. */ redirectUrl?: InputMaybe; @@ -16107,11 +15853,19 @@ export type OrderBulkCreateInput = { export type OrderBulkCreateInvoiceInput = { /** The date, when the invoice was created. */ createdAt: Scalars['DateTime']['input']; - /** Metadata of the invoice. */ + /** + * Metadata of the invoice. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ metadata?: InputMaybe>; /** Invoice number. */ number?: InputMaybe; - /** Private metadata of the invoice. */ + /** + * Private metadata of the invoice. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ privateMetadata?: InputMaybe>; /** URL of the invoice to download. */ url?: InputMaybe; @@ -16139,21 +15893,43 @@ export type OrderBulkCreateOrderLineInput = { isGiftCard: Scalars['Boolean']['input']; /** Determines whether shipping of the order line items is required. */ isShippingRequired: Scalars['Boolean']['input']; - /** Metadata of the order line. */ + /** + * Metadata of the order line. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ metadata?: InputMaybe>; - /** Private metadata of the order line. */ + /** + * Private metadata of the order line. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ privateMetadata?: InputMaybe>; /** The name of the product. */ productName?: InputMaybe; + /** + * The SKU of the product. + * + * Added in Saleor 3.18. + */ + productSku?: InputMaybe; /** Number of items in the order line */ quantity: Scalars['Int']['input']; /** The ID of the tax class. */ taxClassId?: InputMaybe; - /** Metadata of the tax class. */ + /** + * Metadata of the tax class. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ taxClassMetadata?: InputMaybe>; /** The name of the tax class. */ taxClassName?: InputMaybe; - /** Private metadata of the tax class. */ + /** + * Private metadata of the tax class. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ taxClassPrivateMetadata?: InputMaybe>; /** Tax rate of the order line. */ taxRate?: InputMaybe; @@ -16165,6 +15941,24 @@ export type OrderBulkCreateOrderLineInput = { translatedVariantName?: InputMaybe; /** Price of the order line excluding applied discount. */ undiscountedTotalPrice: TaxedMoneyInput; + /** + * Reason of the discount on order line. + * + * Added in Saleor 3.19. + */ + unitDiscountReason?: InputMaybe; + /** + * Type of the discount: fixed or percent + * + * Added in Saleor 3.19. + */ + unitDiscountType?: InputMaybe; + /** + * Value of the discount. Can store fixed value or percent value + * + * Added in Saleor 3.19. + */ + unitDiscountValue?: InputMaybe; /** The external ID of the product variant. */ variantExternalReference?: InputMaybe; /** The ID of the product variant. */ @@ -16194,13 +15988,7 @@ export type OrderBulkCreateUserInput = { id?: InputMaybe; }; -/** - * Event sent when orders are imported. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when orders are imported. */ export type OrderBulkCreated = Event & { __typename?: 'OrderBulkCreated'; /** Time of the event. */ @@ -16225,15 +16013,11 @@ export type OrderCancel = { errors: Array; /** Canceled order. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; -/** - * Event sent when order is canceled. - * - * Added in Saleor 3.2. - */ +/** Event sent when order is canceled. */ export type OrderCancelled = Event & { __typename?: 'OrderCancelled'; /** Time of the event. */ @@ -16258,7 +16042,7 @@ export type OrderCapture = { errors: Array; /** Captured order. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -16289,6 +16073,14 @@ export enum OrderChargeStatusEnum { Partial = 'PARTIAL' } +/** Filter by charge status. */ +export type OrderChargeStatusEnumFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value included in. */ + oneOf?: InputMaybe>; +}; + /** * Confirms an unconfirmed order by changing status to unfulfilled. * @@ -16297,16 +16089,13 @@ export enum OrderChargeStatusEnum { export type OrderConfirm = { __typename?: 'OrderConfirm'; errors: Array; + /** Order which has been confirmed. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; -/** - * Event sent when order is confirmed. - * - * Added in Saleor 3.2. - */ +/** Event sent when order is confirmed. */ export type OrderConfirmed = Event & { __typename?: 'OrderConfirmed'; /** Time of the event. */ @@ -16341,8 +16130,6 @@ export type OrderCountableEdge = { /** * Create new order from existing checkout. Requires the following permissions: AUTHENTICATED_APP and HANDLE_CHECKOUTS. * - * Added in Saleor 3.2. - * * 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. @@ -16376,7 +16163,6 @@ export type OrderCreateFromCheckoutError = { variants?: Maybe>; }; -/** An enumeration. */ export enum OrderCreateFromCheckoutErrorCode { BillingAddressNotSet = 'BILLING_ADDRESS_NOT_SET', ChannelInactive = 'CHANNEL_INACTIVE', @@ -16394,11 +16180,7 @@ export enum OrderCreateFromCheckoutErrorCode { VoucherNotApplicable = 'VOUCHER_NOT_APPLICABLE' } -/** - * Event sent when new order is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new order is created. */ export type OrderCreated = Event & { __typename?: 'OrderCreated'; /** Time of the event. */ @@ -16423,7 +16205,10 @@ export enum OrderDirection { /** Contains all details related to the applied discount to the order. */ export type OrderDiscount = Node & { __typename?: 'OrderDiscount'; - /** Returns amount of discount. */ + /** + * Returns amount of discount. + * @deprecated Use `total` instead. + */ amount: Money; /** The ID of discount applied. */ id: Scalars['ID']['output']; @@ -16435,6 +16220,12 @@ export type OrderDiscount = Node & { * Requires one of the following permissions: MANAGE_ORDERS. */ reason?: Maybe; + /** + * The amount of discount applied to the order. + * + * Added in Saleor 3.21. + */ + total: Money; /** Translated name of the applied discount. */ translatedName?: Maybe; /** The type of applied discount: Sale, Voucher or Manual. */ @@ -16455,7 +16246,7 @@ export type OrderDiscountAdd = { errors: Array; /** Order which has been discounted. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -16478,11 +16269,10 @@ export type OrderDiscountDelete = { errors: Array; /** Order which has removed discount. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; -/** An enumeration. */ export enum OrderDiscountType { Manual = 'MANUAL', OrderPromotion = 'ORDER_PROMOTION', @@ -16501,7 +16291,7 @@ export type OrderDiscountUpdate = { errors: Array; /** Order which has been discounted. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -16531,7 +16321,6 @@ export type OrderError = { warehouse?: Maybe; }; -/** An enumeration. */ export enum OrderErrorCode { BillingAddressNotSet = 'BILLING_ADDRESS_NOT_SET', CannotCancelFulfillment = 'CANNOT_CANCEL_FULFILLMENT', @@ -16551,6 +16340,7 @@ export enum OrderErrorCode { InvalidQuantity = 'INVALID_QUANTITY', InvalidVoucher = 'INVALID_VOUCHER', InvalidVoucherCode = 'INVALID_VOUCHER_CODE', + MissingAddressData = 'MISSING_ADDRESS_DATA', NonEditableGiftLine = 'NON_EDITABLE_GIFT_LINE', NonRemovableGiftLine = 'NON_REMOVABLE_GIFT_LINE', NotAvailableInChannel = 'NOT_AVAILABLE_IN_CHANNEL', @@ -16610,13 +16400,7 @@ export type OrderEvent = Node & { quantity?: Maybe; /** The reference of payment's transaction. */ reference?: Maybe; - /** - * The order event which is related to this event. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The order event which is related to this event. */ related?: Maybe; /** The order which is related to this order. */ relatedOrder?: Maybe; @@ -16667,6 +16451,14 @@ export type OrderEventDiscountObject = { valueType: DiscountValueTypeEnum; }; +/** Filter input for order events data. */ +export type OrderEventFilterInput = { + /** Filter order events by date. */ + date?: InputMaybe; + /** Filter order events by type. */ + type?: InputMaybe; +}; + export type OrderEventOrderLineObject = { __typename?: 'OrderEventOrderLineObject'; /** The discount applied to the order line. */ @@ -16679,7 +16471,13 @@ export type OrderEventOrderLineObject = { quantity?: Maybe; }; -/** An enumeration. */ +export type OrderEventTypeEnumFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value included in. */ + oneOf?: InputMaybe>; +}; + export enum OrderEventsEmailsEnum { Confirmed = 'CONFIRMED', DigitalLinks = 'DIGITAL_LINKS', @@ -16734,6 +16532,7 @@ export enum OrderEventsEnum { PaymentRefunded = 'PAYMENT_REFUNDED', PaymentVoided = 'PAYMENT_VOIDED', Placed = 'PLACED', + PlacedAutomaticallyFromPaidCheckout = 'PLACED_AUTOMATICALLY_FROM_PAID_CHECKOUT', PlacedFromDraft = 'PLACED_FROM_DRAFT', RemovedProducts = 'REMOVED_PRODUCTS', TrackingUpdated = 'TRACKING_UPDATED', @@ -16745,13 +16544,7 @@ export enum OrderEventsEnum { UpdatedAddress = 'UPDATED_ADDRESS' } -/** - * Event sent when order becomes expired. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when order becomes expired. */ export type OrderExpired = Event & { __typename?: 'OrderExpired'; /** Time of the event. */ @@ -16787,11 +16580,7 @@ export type OrderFilterInput = { updatedAt?: InputMaybe; }; -/** - * Filter shipping methods for order. - * - * Added in Saleor 3.6. - */ +/** Filter shipping methods for order. */ export type OrderFilterShippingMethods = Event & { __typename?: 'OrderFilterShippingMethods'; /** Time of the event. */ @@ -16802,11 +16591,7 @@ export type OrderFilterShippingMethods = Event & { order?: Maybe; /** The application receiving the webhook. */ recipient?: Maybe; - /** - * Shipping methods that can be used with this checkout. - * - * Added in Saleor 3.6. - */ + /** Shipping methods that can be used with this checkout. */ shippingMethods?: Maybe>; /** Saleor version that triggered the event. */ version?: Maybe; @@ -16830,7 +16615,7 @@ export type OrderFulfill = { fulfillments?: Maybe>; /** Fulfilled order. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -16841,11 +16626,7 @@ export type OrderFulfillInput = { lines: Array; /** If true, send an email notification to the customer. */ notifyCustomer?: InputMaybe; - /** - * Fulfillment tracking number. - * - * Added in Saleor 3.6. - */ + /** Fulfillment tracking number. */ trackingNumber?: InputMaybe; }; @@ -16863,11 +16644,7 @@ export type OrderFulfillStockInput = { warehouse: Scalars['ID']['input']; }; -/** - * Event sent when order is fulfilled. - * - * Added in Saleor 3.2. - */ +/** Event sent when order is fulfilled. */ export type OrderFulfilled = Event & { __typename?: 'OrderFulfilled'; /** Time of the event. */ @@ -16882,11 +16659,7 @@ export type OrderFulfilled = Event & { version?: Maybe; }; -/** - * Event sent when order is fully paid. - * - * Added in Saleor 3.2. - */ +/** Event sent when order is fully paid. */ export type OrderFullyPaid = Event & { __typename?: 'OrderFullyPaid'; /** Time of the event. */ @@ -16901,13 +16674,7 @@ export type OrderFullyPaid = Event & { version?: Maybe; }; -/** - * The order is fully refunded. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** The order is fully refunded. */ export type OrderFullyRefunded = Event & { __typename?: 'OrderFullyRefunded'; /** Time of the event. */ @@ -16925,10 +16692,6 @@ export type OrderFullyRefunded = Event & { /** * Adds granted refund to the order. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ export type OrderGrantRefundCreate = { @@ -16946,19 +16709,12 @@ export type OrderGrantRefundCreateError = { code: OrderGrantRefundCreateErrorCode; /** 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; - /** - * List of lines which cause the error. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of lines which cause the error. */ lines?: Maybe>; /** The error message. */ message?: Maybe; }; -/** An enumeration. */ export enum OrderGrantRefundCreateErrorCode { AmountGreaterThanAvailable = 'AMOUNT_GREATER_THAN_AVAILABLE', GraphqlError = 'GRAPHQL_ERROR', @@ -16971,32 +16727,26 @@ export enum OrderGrantRefundCreateErrorCode { export type OrderGrantRefundCreateInput = { /** Amount of the granted refund. If not provided, the amount will be calculated automatically based on provided `lines` and `grantRefundForShipping`. */ amount?: InputMaybe; - /** - * Determine if granted refund should include shipping costs. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Determine if granted refund should include shipping costs. */ grantRefundForShipping?: InputMaybe; - /** - * Lines to assign to granted refund. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Lines to assign to granted refund. */ lines?: InputMaybe>; /** Reason of the granted refund. */ reason?: InputMaybe; /** - * The ID of the transaction item related to the granted refund. If `amount` provided in the input, the transaction.chargedAmount needs to be equal or greater than provided `amount`.If `amount` is not provided in the input and calculated automatically by Saleor, the `min(calculatedAmount, transaction.chargedAmount)` will be used.Field will be required starting from Saleor 3.21. + * ID of a `Page` (Model) to reference in reason. + * + * Added in Saleor 3.22. + */ + reasonReference?: InputMaybe; + /** + * The ID of the transaction item related to the granted refund. If `amount` provided in the input, the transaction.chargedAmount needs to be equal or greater than provided `amount`.If `amount` is not provided in the input and calculated automatically by Saleor, the `min(calculatedAmount, transaction.chargedAmount)` will be used. Field required starting from Saleor 3.21. * * Added in Saleor 3.20. * * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ - transactionId?: InputMaybe; + transactionId: Scalars['ID']['input']; }; export type OrderGrantRefundCreateLineError = { @@ -17011,7 +16761,6 @@ export type OrderGrantRefundCreateLineError = { message?: Maybe; }; -/** An enumeration. */ export enum OrderGrantRefundCreateLineErrorCode { GraphqlError = 'GRAPHQL_ERROR', NotFound = 'NOT_FOUND', @@ -17030,10 +16779,6 @@ export type OrderGrantRefundCreateLineInput = { /** * Updates granted refund. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ export type OrderGrantRefundUpdate = { @@ -17047,13 +16792,7 @@ export type OrderGrantRefundUpdate = { export type OrderGrantRefundUpdateError = { __typename?: 'OrderGrantRefundUpdateError'; - /** - * List of lines to add which cause the error. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of lines to add which cause the error. */ addLines?: Maybe>; /** The error code. */ code: OrderGrantRefundUpdateErrorCode; @@ -17061,17 +16800,10 @@ export type OrderGrantRefundUpdateError = { field?: Maybe; /** The error message. */ message?: Maybe; - /** - * List of lines to remove which cause the error. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of lines to remove which cause the error. */ removeLines?: Maybe>; }; -/** An enumeration. */ export enum OrderGrantRefundUpdateErrorCode { AmountGreaterThanAvailable = 'AMOUNT_GREATER_THAN_AVAILABLE', GraphqlError = 'GRAPHQL_ERROR', @@ -17082,33 +16814,21 @@ export enum OrderGrantRefundUpdateErrorCode { } export type OrderGrantRefundUpdateInput = { - /** - * Lines to assign to granted refund. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Lines to assign to granted refund. */ addLines?: InputMaybe>; /** Amount of the granted refund. if not provided and `addLines` or `removeLines` or `grantRefundForShipping` is provided, amount will be calculated automatically. */ amount?: InputMaybe; - /** - * Determine if granted refund should include shipping costs. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Determine if granted refund should include shipping costs. */ grantRefundForShipping?: InputMaybe; /** Reason of the granted refund. */ reason?: InputMaybe; /** - * Lines to remove from granted refund. + * ID of a `Page` (Model) to reference in reason. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Added in Saleor 3.22. */ + reasonReference?: InputMaybe; + /** Lines to remove from granted refund. */ removeLines?: InputMaybe>; /** * The ID of the transaction item related to the granted refund. If `amount` provided in the input, the transaction.chargedAmount needs to be equal or greater than provided `amount`.If `amount` is not provided in the input and calculated automatically by Saleor, the `min(calculatedAmount, transaction.chargedAmount)` will be used.Field will be required starting from Saleor 3.21. @@ -17141,20 +16861,13 @@ export type OrderGrantRefundUpdateLineError = { message?: Maybe; }; -/** An enumeration. */ export enum OrderGrantRefundUpdateLineErrorCode { GraphqlError = 'GRAPHQL_ERROR', NotFound = 'NOT_FOUND', QuantityGreaterThanAvailable = 'QUANTITY_GREATER_THAN_AVAILABLE' } -/** - * The details of granted refund. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** The details of granted refund. */ export type OrderGrantedRefund = { __typename?: 'OrderGrantedRefund'; /** Refund amount. */ @@ -17164,23 +16877,21 @@ export type OrderGrantedRefund = { /** Time of creation. */ createdAt: Scalars['DateTime']['output']; id: Scalars['ID']['output']; + /** Lines assigned to the granted refund. */ + lines?: Maybe>; /** - * Lines assigned to the granted refund. + * Reason of the refund. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Added in Saleor 3.22. */ - lines?: Maybe>; - /** Reason of the refund. */ reason?: Maybe; /** - * If true, the refunded amount includes the shipping price.If false, the refunded amount does not include the shipping price. - * - * Added in Saleor 3.15. + * Reason Model (Page) reference for refund. * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Added in Saleor 3.22. */ + reasonReference?: Maybe; + /** If true, the refunded amount includes the shipping price.If false, the refunded amount does not include the shipping price. */ shippingCostsIncluded: Scalars['Boolean']['output']; /** * Status of the granted refund calculated based on transactionItem assigned to granted refund. @@ -17206,13 +16917,7 @@ export type OrderGrantedRefund = { user?: Maybe; }; -/** - * Represents granted refund line. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents granted refund line. */ export type OrderGrantedRefundLine = { __typename?: 'OrderGrantedRefundLine'; id: Scalars['ID']['output']; @@ -17249,6 +16954,12 @@ export type OrderLine = Node & ObjectWithMetadata & { */ allocations?: Maybe>; digitalContentUrl?: Maybe; + /** + * List of applied discounts + * + * Added in Saleor 3.21. + */ + discounts?: Maybe>; /** ID of the order line. */ id: Scalars['ID']['output']; /** @@ -17259,53 +16970,29 @@ export type OrderLine = Node & ObjectWithMetadata & { * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ isGift?: Maybe; - /** - * Returns True, if the line unit price was overridden. - * - * Added in Saleor 3.14. - */ + /** Returns True, if the line unit price was overridden. */ isPriceOverridden?: Maybe; /** Whether the product variant requires shipping. */ isShippingRequired: Scalars['Boolean']['output']; - /** - * List of public metadata items. Can be accessed without permissions. - * - * Added in Saleor 3.5. - */ + /** List of public metadata items. Can be accessed without permissions. */ metadata: Array; /** * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.5. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.5. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; - /** - * List of private metadata items. Requires staff permissions to access. - * - * Added in Saleor 3.5. - */ + /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; /** * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.5. */ 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. - * - * Added in Saleor 3.5. - */ + /** 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; /** Name of the product in order line. */ productName: Scalars['String']['output']; @@ -17317,43 +17004,21 @@ export type OrderLine = Node & ObjectWithMetadata & { quantity: Scalars['Int']['output']; /** Number of variant items fulfilled. */ quantityFulfilled: Scalars['Int']['output']; - /** - * A quantity of items remaining to be fulfilled. - * - * Added in Saleor 3.1. - */ + /** A quantity of items remaining to be fulfilled. */ quantityToFulfill: Scalars['Int']['output']; - /** - * Denormalized sale ID, set when order line is created for a product variant that is on sale. - * - * Added in Saleor 3.14. - */ + /** Denormalized sale ID, set when order line is created for a product variant that is on sale. */ saleId?: Maybe; /** * Denormalized tax class of the product in this order line. * - * Added in Saleor 3.9. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */ taxClass?: Maybe; - /** - * Denormalized public metadata of the tax class. - * - * Added in Saleor 3.9. - */ + /** Denormalized public metadata of the tax class. */ taxClassMetadata: Array; - /** - * Denormalized name of the tax class. - * - * Added in Saleor 3.9. - */ + /** Denormalized name of the tax class. */ taxClassName?: Maybe; - /** - * Denormalized private metadata of the tax class. Requires staff permissions to access. - * - * Added in Saleor 3.9. - */ + /** Denormalized private metadata of the tax class. Requires staff permissions to access. */ taxClassPrivateMetadata: Array; /** Rate of tax applied on product variant. */ taxRate: Scalars['Float']['output']; @@ -17366,27 +17031,23 @@ export type OrderLine = Node & ObjectWithMetadata & { translatedVariantName: Scalars['String']['output']; /** Price of the order line without discounts. */ undiscountedTotalPrice: TaxedMoney; - /** Price of the single item in the order line without applied an order line discount. */ + /** Price of the single item in the order line without any discount applied. */ undiscountedUnitPrice: TaxedMoney; - /** The discount applied to the single order line. */ + /** 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 any discounts applied on a product in the order. */ + /** 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?: Maybe; - /** Type of the discount: fixed or percent */ + /** 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?: Maybe; - /** Value of the discount. Can store fixed value or percent value */ + /** 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: Scalars['PositiveDecimal']['output']; - /** Price of the single item in the order line. */ + /** Price of the single item in the order line with all the line-level discounts and order-level discount portions applied. */ unitPrice: TaxedMoney; /** A purchased product variant. Note: this field may be null if the variant has been removed from stock at all. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. */ variant?: Maybe; /** Name of the variant of product in order line. */ variantName: Scalars['String']['output']; - /** - * Voucher code that was used for this order line. - * - * Added in Saleor 3.14. - */ + /** Voucher code that was used for this order line. */ voucherCode?: Maybe; }; @@ -17422,19 +17083,9 @@ export type OrderLineThumbnailArgs = { }; export type OrderLineCreateInput = { - /** - * Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. - * - * Added in Saleor 3.6. - */ + /** 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. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** 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; /** Number of variant items ordered. */ quantity: Scalars['Int']['input']; @@ -17452,12 +17103,39 @@ export type OrderLineDelete = { errors: Array; /** A related order. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; /** An order line that was deleted. */ orderLine?: Maybe; }; +/** Represent the discount applied to order line. */ +export type OrderLineDiscount = { + __typename?: 'OrderLineDiscount'; + /** The ID of discount applied. */ + id: Scalars['ID']['output']; + /** The name of applied discount. */ + name?: Maybe; + /** + * Explanation for the applied discount. + * + * Requires one of the following permissions: MANAGE_ORDERS. + */ + reason?: Maybe; + /** The discount amount applied to the line item. */ + total: Money; + /** Translated name of the applied discount. */ + translatedName?: Maybe; + /** The type of applied discount: Sale, Voucher or Manual. */ + type: OrderDiscountType; + /** The discount amount applied to the single line unit. */ + unit: Money; + /** Value of the discount. Can store fixed value or percent value */ + value: Scalars['PositiveDecimal']['output']; + /** Type of the discount: fixed or percent */ + valueType: DiscountValueTypeEnum; +}; + /** * Remove discount applied to the order line. * @@ -17468,7 +17146,7 @@ export type OrderLineDiscountRemove = { errors: Array; /** Order which is related to line which has removed discount. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; /** Order line which has removed discount. */ orderLine?: Maybe; @@ -17484,7 +17162,7 @@ export type OrderLineDiscountUpdate = { errors: Array; /** Order which is related to the discounted line. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; /** Order line which has been discounted. */ orderLine?: Maybe; @@ -17505,13 +17183,13 @@ export type OrderLineUpdate = { errors: Array; /** Related order. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; orderLine?: Maybe; }; /** - * Create order lines for an order. + * Creates order lines for an order. * * Requires one of the following permissions: MANAGE_ORDERS. */ @@ -17520,7 +17198,7 @@ export type OrderLinesCreate = { errors: Array; /** Related order. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; /** List of added order lines. */ orderLines?: Maybe>; @@ -17536,15 +17214,11 @@ export type OrderMarkAsPaid = { errors: Array; /** Order marked as paid. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; -/** - * Event sent when order metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when order metadata is updated. */ export type OrderMetadataUpdated = Event & { __typename?: 'OrderMetadataUpdated'; /** Time of the event. */ @@ -17562,10 +17236,6 @@ export type OrderMetadataUpdated = Event & { /** * Adds note to the order. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ export type OrderNoteAdd = { @@ -17587,7 +17257,6 @@ export type OrderNoteAddError = { message?: Maybe; }; -/** An enumeration. */ export enum OrderNoteAddErrorCode { GraphqlError = 'GRAPHQL_ERROR', Required = 'REQUIRED' @@ -17601,10 +17270,6 @@ export type OrderNoteInput = { /** * Updates note of an order. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ export type OrderNoteUpdate = { @@ -17626,7 +17291,6 @@ export type OrderNoteUpdateError = { message?: Maybe; }; -/** An enumeration. */ export enum OrderNoteUpdateErrorCode { GraphqlError = 'GRAPHQL_ERROR', NotFound = 'NOT_FOUND', @@ -17635,7 +17299,6 @@ export enum OrderNoteUpdateErrorCode { export type OrderOrCheckout = Checkout | Order; -/** An enumeration. */ export enum OrderOriginEnum { BulkCreate = 'BULK_CREATE', Checkout = 'CHECKOUT', @@ -17643,13 +17306,7 @@ export enum OrderOriginEnum { Reissue = 'REISSUE' } -/** - * Payment has been made. The order may be partially or fully paid. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Payment has been made. The order may be partially or fully paid. */ export type OrderPaid = Event & { __typename?: 'OrderPaid'; /** Time of the event. */ @@ -17683,7 +17340,7 @@ export type OrderRefund = { errors: Array; /** A refunded order. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -17712,13 +17369,7 @@ export type OrderRefundProductsInput = { orderLines?: InputMaybe>; }; -/** - * The order received a refund. The order may be partially or fully refunded. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** The order received a refund. The order may be partially or fully refunded. */ export type OrderRefunded = Event & { __typename?: 'OrderRefunded'; /** Time of the event. */ @@ -17767,33 +17418,23 @@ export type OrderReturnProductsInput = { /** Represents the channel-specific order settings. */ export type OrderSettings = { __typename?: 'OrderSettings'; - /** - * Determine if it is possible to place unpaid order by calling `checkoutComplete` mutation. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Determine if it is possible to place unpaid order by calling `checkoutComplete` mutation. */ allowUnpaidOrders: Scalars['Boolean']['output']; /** When disabled, all new orders from checkout will be marked as unconfirmed. When enabled orders from checkout will become unfulfilled immediately. */ automaticallyConfirmAllNewOrders: Scalars['Boolean']['output']; /** When enabled, all non-shippable gift card orders will be fulfilled automatically. */ automaticallyFulfillNonShippableGiftCard: Scalars['Boolean']['output']; - /** - * The time in days after expired orders will be deleted. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The time in days after expired orders will be deleted. */ deleteExpiredOrdersAfter: Scalars['Day']['output']; /** - * Expiration time in minutes. Default null - means do not expire any orders. + * Time in hours after which the draft order line price will be refreshed. * - * Added in Saleor 3.13. + * Added in Saleor 3.21. * * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ + draftOrderLinePriceFreezePeriod?: Maybe; + /** Expiration time in minutes. Default null - means do not expire any orders. */ expireOrdersAfter?: Maybe; /** * Determine if voucher applied on draft order should be count toward voucher usage. @@ -17807,12 +17448,17 @@ export type OrderSettings = { * Determine what strategy will be used to mark the order as paid. Based on the chosen option, the proper object will be created and attached to the order when it's manually marked as paid. * `PAYMENT_FLOW` - [default option] creates the `Payment` object. * `TRANSACTION_FLOW` - creates the `TransactionItem` object. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ markAsPaidStrategy: MarkAsPaidStrategyEnum; + /** + * 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. + */ + useLegacyLineDiscountPropagation: Scalars['Boolean']['output']; }; export type OrderSettingsError = { @@ -17825,39 +17471,28 @@ export type OrderSettingsError = { message?: Maybe; }; -/** An enumeration. */ export enum OrderSettingsErrorCode { Invalid = 'INVALID' } export type OrderSettingsInput = { - /** - * Determine if it is possible to place unpaid order by calling `checkoutComplete` mutation. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Determine if it is possible to place unpaid order by calling `checkoutComplete` mutation. */ allowUnpaidOrders?: InputMaybe; /** When disabled, all new orders from checkout will be marked as unconfirmed. When enabled orders from checkout will become unfulfilled immediately. By default set to True */ automaticallyConfirmAllNewOrders?: InputMaybe; /** When enabled, all non-shippable gift card orders will be fulfilled automatically. By default set to True. */ automaticallyFulfillNonShippableGiftCard?: InputMaybe; - /** - * The time in days after expired orders will be deleted.Allowed range is from 1 to 120. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The time in days after expired orders will be deleted.Allowed range is from 1 to 120. */ deleteExpiredOrdersAfter?: InputMaybe; /** - * Expiration time in minutes. Default null - means do not expire any orders. Enter 0 or null to disable. + * Time in hours after which the draft order line price will be refreshed. Default value is 24 hours. Enter 0 or null to disable. * - * Added in Saleor 3.13. + * Added in Saleor 3.21. * * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ + draftOrderLinePriceFreezePeriod?: InputMaybe; + /** Expiration time in minutes. Default null - means do not expire any orders. Enter 0 or null to disable. */ expireOrdersAfter?: InputMaybe; /** * Specify whether a coupon applied to draft orders will count toward voucher usage. @@ -17873,12 +17508,17 @@ export type OrderSettingsInput = { * Determine what strategy will be used to mark the order as paid. Based on the chosen option, the proper object will be created and attached to the order when it's manually marked as paid. * `PAYMENT_FLOW` - [default option] creates the `Payment` object. * `TRANSACTION_FLOW` - creates the `TransactionItem` object. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ markAsPaidStrategy?: InputMaybe; + /** + * 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. + */ + useLegacyLineDiscountPropagation?: InputMaybe; }; /** @@ -17891,7 +17531,7 @@ export type OrderSettingsUpdate = { errors: Array; /** Order settings. */ orderSettings?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderSettingsErrors: Array; }; @@ -17903,30 +17543,34 @@ export type OrderSettingsUpdateInput = { }; export enum OrderSortField { - /** - * Sort orders by creation date. - * - * DEPRECATED: this field will be removed in Saleor 4.0. - */ + /** Sort orders by creation date. */ CreatedAt = 'CREATED_AT', /** - * Sort orders by creation date. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * Sort orders by creation date + * @deprecated Use `CREATED_AT` instead. */ CreationDate = 'CREATION_DATE', /** Sort orders by customer. */ Customer = 'CUSTOMER', - /** Sort orders by fulfillment status. */ + /** + * Sort orders by fulfillment status. + * @deprecated Use `STATUS` instead. + */ FulfillmentStatus = 'FULFILLMENT_STATUS', - /** Sort orders by last modified at. */ + /** Sort orders by last modified date. */ LastModifiedAt = 'LAST_MODIFIED_AT', /** Sort orders by number. */ Number = 'NUMBER', - /** Sort orders by payment. */ + /** Sort orders by payment status. */ Payment = 'PAYMENT', /** Sort orders by rank. Note: This option is available only with the `search` filter. */ - Rank = 'RANK' + Rank = 'RANK', + /** + * Sort orders by order status. + * + * Added in Saleor 3.22. + */ + Status = 'STATUS' } export type OrderSortingInput = { @@ -17936,7 +17580,6 @@ export type OrderSortingInput = { field: OrderSortField; }; -/** An enumeration. */ export enum OrderStatus { Canceled = 'CANCELED', Draft = 'DRAFT', @@ -17949,6 +17592,14 @@ export enum OrderStatus { Unfulfilled = 'UNFULFILLED' } +/** Filter by order status. */ +export type OrderStatusEnumFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value included in. */ + oneOf?: InputMaybe>; +}; + export enum OrderStatusFilter { Canceled = 'CANCELED', Fulfilled = 'FULFILLED', @@ -17968,19 +17619,37 @@ export type OrderUpdate = { __typename?: 'OrderUpdate'; errors: Array; order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; export type OrderUpdateInput = { /** Billing address of the customer. */ billingAddress?: InputMaybe; + /** External ID of this order. */ + externalReference?: InputMaybe; /** - * External ID of this order. + * Order language code. * - * Added in Saleor 3.10. + * Added in Saleor 3.21. */ - externalReference?: InputMaybe; + languageCode?: InputMaybe; + /** + * Order public metadata. + * + * Added in Saleor 3.21.Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ + metadata?: InputMaybe>; + /** + * Order private metadata. + * + * Added in Saleor 3.21.Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ + privateMetadata?: InputMaybe>; /** Shipping address of the customer. */ shippingAddress?: InputMaybe; /** Email address of the customer. */ @@ -17997,7 +17666,7 @@ export type OrderUpdateShipping = { errors: Array; /** Order with updated shipping method. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -18006,11 +17675,7 @@ export type OrderUpdateShippingInput = { shippingMethod?: InputMaybe; }; -/** - * Event sent when order is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when order is updated. */ export type OrderUpdated = Event & { __typename?: 'OrderUpdated'; /** Time of the event. */ @@ -18035,14 +17700,116 @@ export type OrderVoid = { errors: Array; /** A voided order. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; +export type OrderWhereInput = { + /** List of conditions that must be met. */ + AND?: InputMaybe>; + /** A list of conditions of which at least one must be met. */ + OR?: InputMaybe>; + /** Filter by authorize status. */ + authorizeStatus?: InputMaybe; + /** Filter by billing address of the order. */ + billingAddress?: InputMaybe; + /** Filter by channel. */ + channelId?: InputMaybe; + /** Filter by charge status. */ + chargeStatus?: InputMaybe; + /** Filter by checkout id. */ + checkoutId?: InputMaybe; + /** Filter by checkout token. */ + checkoutToken?: InputMaybe; + /** Filter order by created at date. */ + createdAt?: InputMaybe; + /** Filter by order events. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. */ + events?: InputMaybe>; + /** Filter by fulfillment data associated with the order. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. */ + fulfillments?: InputMaybe>; + /** Filter by whether the order has any fulfillments. */ + hasFulfillments?: InputMaybe; + /** Filter by whether the order has any invoices. */ + hasInvoices?: InputMaybe; + ids?: InputMaybe>; + /** Filter by invoice data associated with the order. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. */ + invoices?: InputMaybe>; + /** Filter by whether the order uses the click and collect delivery method. */ + isClickAndCollect?: InputMaybe; + /** Filter based on whether the order includes a gift card purchase. */ + isGiftCardBought?: InputMaybe; + /** Filter based on whether a gift card was used in the order. */ + isGiftCardUsed?: InputMaybe; + /** Filter by line items associated with the order. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. */ + lines?: InputMaybe>; + /** Filter by number of lines in the order. */ + linesCount?: InputMaybe; + /** Filter by metadata fields. */ + metadata?: InputMaybe; + /** Filter by order number. */ + number?: InputMaybe; + /** Filter by the product type of related order lines. */ + productTypeId?: InputMaybe; + /** Filter by shipping address of the order. */ + shippingAddress?: InputMaybe; + /** Filter by order status. */ + status?: InputMaybe; + /** Filter by total gross amount of the order. */ + totalGross?: InputMaybe; + /** Filter by total net amount of the order. */ + totalNet?: InputMaybe; + /** Filter by transaction data associated with the order. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. */ + transactions?: InputMaybe>; + /** Filter order by updated at date. */ + updatedAt?: InputMaybe; + /** Filter by user. */ + user?: InputMaybe; + /** Filter by user email. */ + userEmail?: InputMaybe; + /** Filter by voucher code used in the order. */ + voucherCode?: InputMaybe; +}; + +/** + * Represents a payment method used for a transaction. + * + * Added in Saleor 3.22. + */ +export type OtherPaymentMethodDetails = PaymentMethodDetails & { + __typename?: 'OtherPaymentMethodDetails'; + /** Name of the payment method. */ + name: Scalars['String']['output']; +}; + +export type OtherPaymentMethodDetailsInput = { + /** Name of the payment method used for the transaction. */ + name: Scalars['String']['input']; +}; + /** A static page that can be manually added by a shop operator through the dashboard. */ -export type Page = Node & ObjectWithMetadata & { +export type Page = Node & ObjectWithAttributes & ObjectWithMetadata & { __typename?: 'Page'; - /** List of attributes assigned to this product. */ + /** + * Get a single attribute attached to page by attribute slug. + * + * Added in Saleor 3.22. + */ + assignedAttribute?: Maybe; + /** + * List of attributes assigned to this page. + * + * Added in Saleor 3.22. + */ + assignedAttributes: Array; + /** + * Get a single attribute attached to page by attribute slug. + * @deprecated Use `assignedAttribute` field instead. + */ + attribute?: Maybe; + /** + * List of attributes assigned to this page. + * @deprecated Use `assignedAttributes` field instead. + */ attributes: Array; /** * Content of the page. @@ -18054,7 +17821,7 @@ export type Page = Node & ObjectWithMetadata & { * Content of the page. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `content` field instead. + * @deprecated Use the `content` field instead. */ contentJson: Scalars['JSONString']['output']; /** Date and time at which page was created. */ @@ -18069,15 +17836,9 @@ export type Page = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Determines the type of page */ pageType: PageType; @@ -18087,23 +17848,13 @@ export type Page = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; - /** @deprecated This field will be removed in Saleor 4.0. Use the `publishedAt` field to fetch the publication date. */ + /** @deprecated Use the `publishedAt` field to fetch the publication date. */ publicationDate?: Maybe; - /** - * The page publication date. - * - * Added in Saleor 3.3. - */ + /** The page publication date. */ publishedAt?: Maybe; /** Description of the page for SEO. */ seoDescription?: Maybe; @@ -18118,6 +17869,24 @@ export type Page = Node & ObjectWithMetadata & { }; +/** A static page that can be manually added by a shop operator through the dashboard. */ +export type PageAssignedAttributeArgs = { + slug: Scalars['String']['input']; +}; + + +/** A static page that can be manually added by a shop operator through the dashboard. */ +export type PageAssignedAttributesArgs = { + limit?: InputMaybe; +}; + + +/** A static page that can be manually added by a shop operator through the dashboard. */ +export type PageAttributeArgs = { + slug: Scalars['String']['input']; +}; + + /** A static page that can be manually added by a shop operator through the dashboard. */ export type PageMetafieldArgs = { key: Scalars['String']['input']; @@ -18155,7 +17924,7 @@ export type PageTranslationArgs = { export type PageAttributeAssign = { __typename?: 'PageAttributeAssign'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; /** The updated page type. */ pageType?: Maybe; @@ -18169,7 +17938,7 @@ export type PageAttributeAssign = { export type PageAttributeUnassign = { __typename?: 'PageAttributeUnassign'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; /** The updated page type. */ pageType?: Maybe; @@ -18185,7 +17954,7 @@ export type PageBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; }; @@ -18199,7 +17968,7 @@ export type PageBulkPublish = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; }; @@ -18229,7 +17998,7 @@ export type PageCreate = { __typename?: 'PageCreate'; errors: Array; page?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; }; @@ -18248,15 +18017,10 @@ export type PageCreateInput = { pageType: Scalars['ID']['input']; /** * Publication date. ISO 8601 standard. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead. + * @deprecated Use `publishedAt` field instead. */ publicationDate?: InputMaybe; - /** - * Publication date time. ISO 8601 standard. - * - * Added in Saleor 3.3. - */ + /** Publication date time. ISO 8601 standard. */ publishedAt?: InputMaybe; /** Search engine optimization fields. */ seo?: InputMaybe; @@ -18266,11 +18030,7 @@ export type PageCreateInput = { title?: InputMaybe; }; -/** - * Event sent when new page is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new page is created. */ export type PageCreated = Event & { __typename?: 'PageCreated'; /** Time of the event. */ @@ -18294,15 +18054,11 @@ export type PageDelete = { __typename?: 'PageDelete'; errors: Array; page?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; }; -/** - * Event sent when page is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when page is deleted. */ export type PageDeleted = Event & { __typename?: 'PageDeleted'; /** Time of the event. */ @@ -18331,7 +18087,6 @@ export type PageError = { values?: Maybe>; }; -/** An enumeration. */ export enum PageErrorCode { AttributeAlreadyAssigned = 'ATTRIBUTE_ALREADY_ASSIGNED', DuplicatedInputItem = 'DUPLICATED_INPUT_ITEM', @@ -18376,15 +18131,10 @@ export type PageInput = { isPublished?: InputMaybe; /** * Publication date. ISO 8601 standard. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead. + * @deprecated Use `publishedAt` field instead. */ publicationDate?: InputMaybe; - /** - * Publication date time. ISO 8601 standard. - * - * Added in Saleor 3.3. - */ + /** Publication date time. ISO 8601 standard. */ publishedAt?: InputMaybe; /** Search engine optimization fields. */ seo?: InputMaybe; @@ -18404,34 +18154,24 @@ export type PageReorderAttributeValues = { errors: Array; /** Page from which attribute values are reordered. */ page?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; }; export enum PageSortField { - /** - * Sort pages by creation date. - * - * DEPRECATED: this field will be removed in Saleor 4.0. - */ + /** Sort pages by creation date. */ CreatedAt = 'CREATED_AT', /** * Sort pages by creation date. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Use `CREATED_AT` instead. */ CreationDate = 'CREATION_DATE', /** * Sort pages by publication date. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Use `PUBLISHED_AT` instead. */ PublicationDate = 'PUBLICATION_DATE', - /** - * Sort pages by publication date. - * - * DEPRECATED: this field will be removed in Saleor 4.0. - */ + /** Sort pages by publication date. */ PublishedAt = 'PUBLISHED_AT', /** Sort pages by slug. */ Slug = 'SLUG', @@ -18463,26 +18203,28 @@ export type PageTranslatableContent = Node & { * Content of the page. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `content` field instead. + * @deprecated Use the `content` field instead. */ contentJson?: Maybe; /** The ID of the page translatable content. */ id: Scalars['ID']['output']; /** * A static page that can be manually added by a shop operator through the dashboard. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ page?: Maybe; - /** - * The ID of the page to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the page to translate. */ pageId: Scalars['ID']['output']; /** SEO description to translate. */ seoDescription?: Maybe; /** SEO title to translate. */ seoTitle?: Maybe; + /** + * Slug to translate. + * + * Added in Saleor 3.21. + */ + slug?: Maybe; /** Page title to translate. */ title: Scalars['String']['output']; /** Returns translated page fields for the given language code. */ @@ -18504,7 +18246,7 @@ export type PageTranslate = { __typename?: 'PageTranslate'; errors: Array; page?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; @@ -18521,7 +18263,7 @@ export type PageTranslation = Node & { * Translated description of the page. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `content` field instead. + * @deprecated Use the `content` field instead. */ contentJson?: Maybe; /** The ID of the page translation. */ @@ -18532,13 +18274,15 @@ export type PageTranslation = Node & { seoDescription?: Maybe; /** Translated SEO title. */ seoTitle?: Maybe; - /** Translated page title. */ - title?: Maybe; /** - * Represents the page fields to translate. + * Translated page slug. * - * Added in Saleor 3.14. + * Added in Saleor 3.21. */ + slug?: Maybe; + /** Translated page title. */ + title?: Maybe; + /** Represents the page fields to translate. */ translatableContent?: Maybe; }; @@ -18551,6 +18295,7 @@ export type PageTranslationInput = { content?: InputMaybe; seoDescription?: InputMaybe; seoTitle?: InputMaybe; + slug?: InputMaybe; title?: InputMaybe; }; @@ -18579,15 +18324,9 @@ export type PageType = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Name of the page type. */ name: Scalars['String']['output']; @@ -18597,15 +18336,9 @@ export type PageType = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** Slug of the page type. */ slug: Scalars['String']['output']; @@ -18619,6 +18352,7 @@ export type PageTypeAvailableAttributesArgs = { filter?: InputMaybe; first?: InputMaybe; last?: InputMaybe; + search?: InputMaybe; where?: InputMaybe; }; @@ -18647,7 +18381,7 @@ export type PageTypePrivateMetafieldsArgs = { }; /** - * Delete page types. + * Deletes page types. * * Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. */ @@ -18656,7 +18390,7 @@ export type PageTypeBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; }; @@ -18678,14 +18412,14 @@ export type PageTypeCountableEdge = { }; /** - * Create a new page type. + * Creates a new page type. * * Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. */ export type PageTypeCreate = { __typename?: 'PageTypeCreate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; pageType?: Maybe; }; @@ -18699,11 +18433,7 @@ export type PageTypeCreateInput = { slug?: InputMaybe; }; -/** - * Event sent when new page type is created. - * - * Added in Saleor 3.5. - */ +/** Event sent when new page type is created. */ export type PageTypeCreated = Event & { __typename?: 'PageTypeCreated'; /** Time of the event. */ @@ -18719,23 +18449,19 @@ export type PageTypeCreated = Event & { }; /** - * Delete a page type. + * Deletes a page type. * * Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. */ export type PageTypeDelete = { __typename?: 'PageTypeDelete'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; pageType?: Maybe; }; -/** - * Event sent when page type is deleted. - * - * Added in Saleor 3.5. - */ +/** Event sent when page type is deleted. */ export type PageTypeDeleted = Event & { __typename?: 'PageTypeDeleted'; /** Time of the event. */ @@ -18763,7 +18489,7 @@ export type PageTypeFilterInput = { export type PageTypeReorderAttributes = { __typename?: 'PageTypeReorderAttributes'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; /** Page type from which attributes are reordered. */ pageType?: Maybe; @@ -18784,14 +18510,14 @@ export type PageTypeSortingInput = { }; /** - * Update page type. + * Updates page type. * * Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. */ export type PageTypeUpdate = { __typename?: 'PageTypeUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; pageType?: Maybe; }; @@ -18807,11 +18533,7 @@ export type PageTypeUpdateInput = { slug?: InputMaybe; }; -/** - * Event sent when page type is updated. - * - * Added in Saleor 3.5. - */ +/** Event sent when page type is updated. */ export type PageTypeUpdated = Event & { __typename?: 'PageTypeUpdated'; /** Time of the event. */ @@ -18835,15 +18557,11 @@ export type PageUpdate = { __typename?: 'PageUpdate'; errors: Array; page?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; }; -/** - * Event sent when page is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when page is updated. */ export type PageUpdated = Event & { __typename?: 'PageUpdated'; /** Time of the event. */ @@ -18858,6 +18576,22 @@ export type PageUpdated = Event & { version?: Maybe; }; +export type PageWhereInput = { + /** List of conditions that must be met. */ + AND?: InputMaybe>; + /** A list of conditions of which at least one must be met. */ + OR?: InputMaybe>; + /** Filter by attributes associated with the page. */ + attributes?: InputMaybe>; + ids?: InputMaybe>; + /** Filter by metadata fields. */ + metadata?: InputMaybe; + /** Filter by page type. */ + pageType?: InputMaybe; + /** Filter by page slug. */ + slug?: InputMaybe; +}; + /** * Change the password of the logged in user. * @@ -18865,7 +18599,7 @@ export type PageUpdated = Event & { */ export type PasswordChange = { __typename?: 'PasswordChange'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** A user instance with a new password. */ @@ -18921,25 +18655,15 @@ export type Payment = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Date and time at which payment was modified. */ modified: Scalars['DateTime']['output']; /** Order associated with a payment. */ order?: Maybe; - /** - * Informs whether this is a partial payment. - * - * Added in Saleor 3.14. - */ + /** Informs whether this is a partial payment. */ partial: Scalars['Boolean']['output']; /** Type of method used for payment. */ paymentMethodType: Scalars['String']['output']; @@ -18949,21 +18673,11 @@ export type Payment = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; - /** - * PSP reference of the payment. - * - * Added in Saleor 3.14. - */ + /** PSP reference of the payment. */ pspReference?: Maybe; /** Unique token associated with a payment. */ token: Scalars['String']['output']; @@ -19001,11 +18715,7 @@ export type PaymentPrivateMetafieldsArgs = { keys?: InputMaybe>; }; -/** - * Authorize payment. - * - * Added in Saleor 3.6. - */ +/** Authorize payment. */ export type PaymentAuthorize = Event & { __typename?: 'PaymentAuthorize'; /** Time of the event. */ @@ -19030,15 +18740,11 @@ export type PaymentCapture = { errors: Array; /** Updated payment. */ payment?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ paymentErrors: Array; }; -/** - * Capture payment. - * - * Added in Saleor 3.6. - */ +/** Capture payment. */ export type PaymentCaptureEvent = Event & { __typename?: 'PaymentCaptureEvent'; /** Time of the event. */ @@ -19053,7 +18759,6 @@ export type PaymentCaptureEvent = Event & { version?: Maybe; }; -/** An enumeration. */ export enum PaymentChargeStatusEnum { Cancelled = 'CANCELLED', FullyCharged = 'FULLY_CHARGED', @@ -19071,7 +18776,7 @@ export type PaymentCheckBalance = { /** Response from the gateway. */ data?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ paymentErrors: Array; }; @@ -19086,11 +18791,7 @@ export type PaymentCheckBalanceInput = { method: Scalars['String']['input']; }; -/** - * Confirm payment. - * - * Added in Saleor 3.6. - */ +/** Confirm payment. */ export type PaymentConfirmEvent = Event & { __typename?: 'PaymentConfirmEvent'; /** Time of the event. */ @@ -19134,13 +18835,13 @@ export type PaymentError = { variants?: Maybe>; }; -/** An enumeration. */ export enum PaymentErrorCode { BalanceCheckError = 'BALANCE_CHECK_ERROR', BillingAddressNotSet = 'BILLING_ADDRESS_NOT_SET', ChannelInactive = 'CHANNEL_INACTIVE', CheckoutCompletionInProgress = 'CHECKOUT_COMPLETION_IN_PROGRESS', CheckoutEmailNotSet = 'CHECKOUT_EMAIL_NOT_SET', + CheckoutHasTransaction = 'CHECKOUT_HAS_TRANSACTION', GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', InvalidShippingMethod = 'INVALID_SHIPPING_METHOD', @@ -19158,11 +18859,7 @@ export enum PaymentErrorCode { export type PaymentFilterInput = { checkouts?: InputMaybe>; - /** - * Filter by ids. - * - * Added in Saleor 3.8. - */ + /** Filter by ids. */ ids?: InputMaybe>; }; @@ -19198,20 +18895,13 @@ export type PaymentGatewayConfigError = { message?: Maybe; }; -/** An enumeration. */ export enum PaymentGatewayConfigErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', NotFound = 'NOT_FOUND' } -/** - * 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. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** 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. */ export type PaymentGatewayInitialize = { __typename?: 'PaymentGatewayInitialize'; errors: Array; @@ -19229,20 +18919,13 @@ export type PaymentGatewayInitializeError = { message?: Maybe; }; -/** An enumeration. */ export enum PaymentGatewayInitializeErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', NotFound = 'NOT_FOUND' } -/** - * Event sent when user wants to initialize the payment gateway. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when user wants to initialize the payment gateway. */ export type PaymentGatewayInitializeSession = Event & { __typename?: 'PaymentGatewayInitializeSession'; /** Amount requested for initializing the payment gateway. */ @@ -19264,10 +18947,6 @@ export type PaymentGatewayInitializeSession = Event & { /** * Initializes payment gateway for tokenizing payment method session. * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_USER. * * Triggers the following webhook events: @@ -19292,7 +18971,6 @@ export type PaymentGatewayInitializeTokenizationError = { message?: Maybe; }; -/** An enumeration. */ export enum PaymentGatewayInitializeTokenizationErrorCode { ChannelInactive = 'CHANNEL_INACTIVE', GatewayError = 'GATEWAY_ERROR', @@ -19315,13 +18993,7 @@ export enum PaymentGatewayInitializeTokenizationResult { SuccessfullyInitialized = 'SUCCESSFULLY_INITIALIZED' } -/** - * Event sent to initialize a new session in payment gateway to store the payment method. - * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** 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. */ @@ -19353,7 +19025,7 @@ export type PaymentInitialize = { errors: Array; /** Payment that was initialized. */ initializedPayment?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ paymentErrors: Array; }; @@ -19374,28 +19046,20 @@ export type PaymentInput = { /** A gateway to use with that payment. */ gateway: Scalars['String']['input']; /** - * User public metadata. + * User public metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.1. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** URL of a storefront view where user should be redirected after requiring additional actions. Payment with additional actions will not be finished if this field is not provided. */ returnUrl?: InputMaybe; - /** - * Payment store type. - * - * Added in Saleor 3.1. - */ + /** Payment store type. */ storePaymentMethod?: InputMaybe; /** Client-side generated payment token, representing customer's billing data in a secure manner. */ token?: InputMaybe; }; -/** - * List payment gateways. - * - * Added in Saleor 3.6. - */ +/** List payment gateways. */ export type PaymentListGateways = Event & { __typename?: 'PaymentListGateways'; /** The checkout the event relates to. */ @@ -19411,11 +19075,41 @@ export type PaymentListGateways = Event & { }; /** - * Tokenize payment method. + * Represents a payment method used for a transaction. * - * Added in Saleor 3.16. + * Added in Saleor 3.22. + */ +export type PaymentMethodDetails = { + /** Name of the payment method. */ + name: Scalars['String']['output']; +}; + +export type PaymentMethodDetailsCardFilterInput = { + /** Filter by payment method brand used to pay for the order. */ + brand?: InputMaybe; +}; + +export type PaymentMethodDetailsFilterInput = { + /** Filter by card details used to pay for the order. Skips `type` filter if provided. */ + card?: InputMaybe; + /** Filter by payment method type used to pay for the order. */ + type?: InputMaybe; +}; + +/** + * Details of the payment method used for the transaction. One of `card` or `other` is required. * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Added in Saleor 3.22. + */ +export type PaymentMethodDetailsInput = { + /** Details of the card payment method used for the transaction. */ + card?: InputMaybe; + /** Details of the non-card payment method used for this transaction. */ + other?: InputMaybe; +}; + +/** + * Tokenize payment method. * * Requires one of the following permissions: AUTHENTICATED_USER. * @@ -19443,7 +19137,6 @@ export type PaymentMethodInitializeTokenizationError = { message?: Maybe; }; -/** An enumeration. */ export enum PaymentMethodInitializeTokenizationErrorCode { ChannelInactive = 'CHANNEL_INACTIVE', GatewayError = 'GATEWAY_ERROR', @@ -19452,13 +19145,7 @@ export enum PaymentMethodInitializeTokenizationErrorCode { NotFound = 'NOT_FOUND' } -/** - * Event sent when user requests a tokenization of payment method. - * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when user requests a tokenization of payment method. */ export type PaymentMethodInitializeTokenizationSession = Event & { __typename?: 'PaymentMethodInitializeTokenizationSession'; /** Channel related to the requested action. */ @@ -19482,10 +19169,6 @@ export type PaymentMethodInitializeTokenizationSession = Event & { /** * Tokenize payment method. * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_USER. * * Triggers the following webhook events: @@ -19512,7 +19195,6 @@ export type PaymentMethodProcessTokenizationError = { message?: Maybe; }; -/** An enumeration. */ export enum PaymentMethodProcessTokenizationErrorCode { ChannelInactive = 'CHANNEL_INACTIVE', GatewayError = 'GATEWAY_ERROR', @@ -19521,13 +19203,7 @@ export enum PaymentMethodProcessTokenizationErrorCode { NotFound = 'NOT_FOUND' } -/** - * Event sent when user continues a tokenization of payment method. - * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when user continues a tokenization of payment method. */ export type PaymentMethodProcessTokenizationSession = Event & { __typename?: 'PaymentMethodProcessTokenizationSession'; /** Channel related to the requested action. */ @@ -19577,10 +19253,25 @@ export enum PaymentMethodTokenizationResult { } /** - * Process payment. + * Represents possible payment method types. * - * Added in Saleor 3.6. + * The following types are possible: + * CARD - represents a card payment method. + * OTHER - represents any payment method that is not a card payment. */ +export enum PaymentMethodTypeEnum { + Card = 'CARD', + Other = 'OTHER' +} + +export type PaymentMethodTypeEnumFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value included in. */ + oneOf?: InputMaybe>; +}; + +/** Process payment. */ export type PaymentProcessEvent = Event & { __typename?: 'PaymentProcessEvent'; /** Time of the event. */ @@ -19605,15 +19296,11 @@ export type PaymentRefund = { errors: Array; /** Updated payment. */ payment?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ paymentErrors: Array; }; -/** - * Refund payment. - * - * Added in Saleor 3.6. - */ +/** Refund payment. */ export type PaymentRefundEvent = Event & { __typename?: 'PaymentRefundEvent'; /** Time of the event. */ @@ -19632,24 +19319,48 @@ export type PaymentRefundEvent = Event & { export type PaymentSettings = { __typename?: '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. + * 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.16. + * Added in Saleor 3.20. + */ + checkoutReleaseFundsCutOffDate?: Maybe; + /** + * The time in hours after which funds for expired checkouts will be released. * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Added in Saleor 3.20. */ + checkoutTtlBeforeReleasingFunds?: Maybe; + /** 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. + * + * Added in Saleor 3.20. + */ + releaseFundsForExpiredCheckouts?: Maybe; }; export type 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. + * 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.16. + * Added in Saleor 3.20. + */ + checkoutReleaseFundsCutOffDate?: InputMaybe; + /** + * The time in hours after which funds for expired checkouts will be released. * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Added in Saleor 3.20. */ + checkoutTtlBeforeReleasingFunds?: InputMaybe; + /** 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?: InputMaybe; + /** + * Determine if the funds for expired checkouts should be released automatically. + * + * Added in Saleor 3.20. + */ + releaseFundsForExpiredCheckouts?: InputMaybe; }; /** Represents a payment source stored for user in payment gateway, such as credit card. */ @@ -19662,8 +19373,6 @@ export type PaymentSource = { /** * List of public metadata items. * - * Added in Saleor 3.1. - * * Can be accessed without permissions. */ metadata: Array; @@ -19681,15 +19390,11 @@ export type PaymentVoid = { errors: Array; /** Updated payment. */ payment?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ paymentErrors: Array; }; -/** - * Void payment. - * - * Added in Saleor 3.6. - */ +/** Void payment. */ export type PaymentVoidEvent = Event & { __typename?: 'PaymentVoidEvent'; /** Time of the event. */ @@ -19713,7 +19418,6 @@ export type Permission = { name: Scalars['String']['output']; }; -/** An enumeration. */ export enum PermissionEnum { HandleCheckouts = 'HANDLE_CHECKOUTS', HandlePayments = 'HANDLE_PAYMENTS', @@ -19753,18 +19457,12 @@ export type PermissionGroupCreate = { __typename?: 'PermissionGroupCreate'; errors: Array; group?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ permissionGroupErrors: Array; }; export type PermissionGroupCreateInput = { - /** - * List of channels to assign to this group. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of channels to assign to this group. */ addChannels?: InputMaybe>; /** List of permission code names to assign to this group. */ addPermissions?: InputMaybe>; @@ -19772,21 +19470,11 @@ export type PermissionGroupCreateInput = { addUsers?: InputMaybe>; /** Group name. */ name: Scalars['String']['input']; - /** - * Determine if the group has restricted access to channels. DEFAULT: False - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Determine if the group has restricted access to channels. DEFAULT: False */ restrictedAccessToChannels?: InputMaybe; }; -/** - * Event sent when new permission group is created. - * - * Added in Saleor 3.6. - */ +/** Event sent when new permission group is created. */ export type PermissionGroupCreated = Event & { __typename?: 'PermissionGroupCreated'; /** Time of the event. */ @@ -19813,15 +19501,11 @@ export type PermissionGroupDelete = { __typename?: 'PermissionGroupDelete'; errors: Array; group?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ permissionGroupErrors: Array; }; -/** - * Event sent when permission group is deleted. - * - * Added in Saleor 3.6. - */ +/** Event sent when permission group is deleted. */ export type PermissionGroupDeleted = Event & { __typename?: 'PermissionGroupDeleted'; /** Time of the event. */ @@ -19852,7 +19536,6 @@ export type PermissionGroupError = { users?: Maybe>; }; -/** An enumeration. */ export enum PermissionGroupErrorCode { AssignNonStaffMember = 'ASSIGN_NON_STAFF_MEMBER', CannotRemoveFromLastGroup = 'CANNOT_REMOVE_FROM_LAST_GROUP', @@ -19895,18 +19578,12 @@ export type PermissionGroupUpdate = { __typename?: 'PermissionGroupUpdate'; errors: Array; group?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ permissionGroupErrors: Array; }; export type PermissionGroupUpdateInput = { - /** - * List of channels to assign to this group. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of channels to assign to this group. */ addChannels?: InputMaybe>; /** List of permission code names to assign to this group. */ addPermissions?: InputMaybe>; @@ -19914,33 +19591,17 @@ export type PermissionGroupUpdateInput = { addUsers?: InputMaybe>; /** Group name. */ name?: InputMaybe; - /** - * List of channels to unassign from this group. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of channels to unassign from this group. */ removeChannels?: InputMaybe>; /** List of permission code names to unassign from this group. */ removePermissions?: InputMaybe>; /** List of users to unassign from this group. */ removeUsers?: InputMaybe>; - /** - * Determine if the group has restricted access to channels. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Determine if the group has restricted access to channels. */ restrictedAccessToChannels?: InputMaybe; }; -/** - * Event sent when permission group is updated. - * - * Added in Saleor 3.6. - */ +/** Event sent when permission group is updated. */ export type PermissionGroupUpdated = Event & { __typename?: 'PermissionGroupUpdated'; /** Time of the event. */ @@ -20013,7 +19674,6 @@ export type PluginError = { message?: Maybe; }; -/** An enumeration. */ export enum PluginErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', @@ -20055,7 +19715,7 @@ export type PluginUpdate = { __typename?: 'PluginUpdate'; errors: Array; plugin?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pluginsErrors: Array; }; @@ -20066,7 +19726,6 @@ export type PluginUpdateInput = { configuration?: InputMaybe>; }; -/** An enumeration. */ export enum PostalCodeRuleInclusionTypeEnum { Exclude = 'EXCLUDE', Include = 'INCLUDE' @@ -20107,6 +19766,13 @@ export type PreorderThreshold = { soldUnits: Scalars['Int']['output']; }; +export type PriceFilterInput = { + /** The amount of the price to filter by. */ + amount: DecimalFilterInput; + /** The currency of the price to filter by. */ + currency?: InputMaybe; +}; + export type PriceInput = { /** Amount of money. */ amount: Scalars['PositiveDecimal']['input']; @@ -20122,19 +19788,33 @@ export type PriceRangeInput = { }; /** Represents an individual item for sale in the storefront. */ -export type Product = Node & ObjectWithMetadata & { +export type Product = Node & ObjectWithAttributes & ObjectWithMetadata & { __typename?: 'Product'; /** * Get a single attribute attached to product by attribute slug. * - * Added in Saleor 3.9. + * Added in Saleor 3.22. + */ + assignedAttribute?: Maybe; + /** + * List of attributes assigned to this product. + * + * Added in Saleor 3.22. + */ + assignedAttributes: Array; + /** + * Get a single attribute attached to product by attribute slug. + * @deprecated Use the `assignedAttribute` field instead. */ attribute?: Maybe; - /** List of attributes assigned to this product. */ + /** + * List of attributes assigned to this product. + * @deprecated Use the `assignedAttributes` field instead. + */ attributes: Array; /** * Date when product is available for purchase. - * @deprecated This field will be removed in Saleor 4.0. Use the `availableForPurchaseAt` field to fetch the available for purchase date. + * @deprecated Use the `availableForPurchaseAt` field to fetch the available for purchase date. */ availableForPurchase?: Maybe; /** Date when product is available for purchase. */ @@ -20148,7 +19828,7 @@ export type Product = Node & ObjectWithMetadata & { * Requires one of the following permissions: MANAGE_PRODUCTS. */ channelListings?: Maybe>; - /** @deprecated This field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` field to determine whether tax collection is enabled. */ + /** @deprecated Use `Channel.taxConfiguration` field to determine whether tax collection is enabled. */ chargeTaxes: Scalars['Boolean']['output']; /** List of collections for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. */ collections?: Maybe>; @@ -20166,25 +19846,21 @@ export type Product = Node & ObjectWithMetadata & { * Description of the product. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `description` field instead. + * @deprecated Use the `description` field instead. */ descriptionJson?: Maybe; - /** - * External ID of this product. - * - * Added in Saleor 3.10. - */ + /** External ID of this product. */ externalReference?: Maybe; /** The ID of the product. */ id: Scalars['ID']['output']; /** * Get a single product image by ID. - * @deprecated This field will be removed in Saleor 4.0. Use the `mediaById` field instead. + * @deprecated Use the `mediaById` field instead. */ imageById?: Maybe; /** * List of images for the product. - * @deprecated This field will be removed in Saleor 4.0. Use the `media` field instead. + * @deprecated Use the `media` field instead. */ images?: Maybe>; /** Whether the product is in stock, set as available for purchase in the given channel, and published. */ @@ -20201,15 +19877,9 @@ export type Product = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** SEO description of the product. */ name: Scalars['String']['output']; @@ -20221,18 +19891,18 @@ export type Product = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** Type of the product. */ productType: ProductType; + /** + * List of variants for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. + * + * Added in Saleor 3.21. + */ + productVariants?: Maybe; /** Rating of the product. */ rating?: Maybe; /** SEO description of the product. */ @@ -20249,7 +19919,7 @@ export type Product = Node & ObjectWithMetadata & { taxClass?: Maybe; /** * A type of tax. Assigned by enabled tax gateway - * @deprecated This field will be removed in Saleor 4.0. Use `taxClass` field instead. + * @deprecated Use `taxClass` field instead. */ taxType?: Maybe; /** Thumbnail of the product. */ @@ -20260,18 +19930,31 @@ export type Product = Node & ObjectWithMetadata & { updatedAt: Scalars['DateTime']['output']; /** * Get a single variant by SKU or ID. - * - * Added in Saleor 3.9. - * @deprecated This field will be removed in Saleor 4.0. Use top-level `variant` query. + * @deprecated Use top-level `variant` query. */ variant?: Maybe; - /** List of variants for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. */ + /** + * List of variants for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. + * @deprecated Use `productVariants` field instead. + */ variants?: Maybe>; /** Weight of the product. */ weight?: Maybe; }; +/** Represents an individual item for sale in the storefront. */ +export type ProductAssignedAttributeArgs = { + slug: Scalars['String']['input']; +}; + + +/** Represents an individual item for sale in the storefront. */ +export type ProductAssignedAttributesArgs = { + limit?: InputMaybe; +}; + + /** Represents an individual item for sale in the storefront. */ export type ProductAttributeArgs = { slug: Scalars['String']['input']; @@ -20280,7 +19963,7 @@ export type ProductAttributeArgs = { /** Represents an individual item for sale in the storefront. */ export type ProductImageByIdArgs = { - id?: InputMaybe; + id: Scalars['ID']['input']; }; @@ -20298,7 +19981,7 @@ export type ProductMediaArgs = { /** Represents an individual item for sale in the storefront. */ export type ProductMediaByIdArgs = { - id?: InputMaybe; + id: Scalars['ID']['input']; }; @@ -20332,6 +20015,18 @@ export type ProductPrivateMetafieldsArgs = { }; +/** Represents an individual item for sale in the storefront. */ +export type ProductProductVariantsArgs = { + after?: InputMaybe; + before?: InputMaybe; + filter?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + sortBy?: InputMaybe; + where?: InputMaybe; +}; + + /** Represents an individual item for sale in the storefront. */ export type ProductThumbnailArgs = { format?: InputMaybe; @@ -20359,7 +20054,7 @@ export type ProductVariantArgs = { export type ProductAttributeAssign = { __typename?: 'ProductAttributeAssign'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; /** The updated product type. */ productType?: Maybe; @@ -20370,25 +20065,19 @@ export type ProductAttributeAssignInput = { id: Scalars['ID']['input']; /** The attribute type to be assigned as. */ type: ProductAttributeType; - /** - * Whether attribute is allowed in variant selection. Allowed types are: ['dropdown', 'boolean', 'swatch', 'numeric']. - * - * Added in Saleor 3.1. - */ + /** Whether attribute is allowed in variant selection. Allowed types are: ['dropdown', 'boolean', 'swatch', 'numeric']. */ variantSelection?: InputMaybe; }; /** * Update attributes assigned to product variant for given product type. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. */ export type ProductAttributeAssignmentUpdate = { __typename?: 'ProductAttributeAssignmentUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; /** The updated product type. */ productType?: Maybe; @@ -20397,11 +20086,7 @@ export type ProductAttributeAssignmentUpdate = { export type ProductAttributeAssignmentUpdateInput = { /** The ID of the attribute to assign. */ id: Scalars['ID']['input']; - /** - * Whether attribute is allowed in variant selection. Allowed types are: ['dropdown', 'boolean', 'swatch', 'numeric']. - * - * Added in Saleor 3.1. - */ + /** Whether attribute is allowed in variant selection. Allowed types are: ['dropdown', 'boolean', 'swatch', 'numeric']. */ variantSelection: Scalars['Boolean']['input']; }; @@ -20418,7 +20103,7 @@ export enum ProductAttributeType { export type ProductAttributeUnassign = { __typename?: 'ProductAttributeUnassign'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; /** The updated product type. */ productType?: Maybe; @@ -20427,10 +20112,6 @@ export type ProductAttributeUnassign = { /** * Creates products. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_PRODUCTS. */ export type ProductBulkCreate = { @@ -20460,7 +20141,6 @@ export type ProductBulkCreateError = { warehouses?: Maybe>; }; -/** An enumeration. */ export enum ProductBulkCreateErrorCode { AttributeAlreadyAssigned = 'ATTRIBUTE_ALREADY_ASSIGNED', AttributeCannotBeAssigned = 'ATTRIBUTE_CANNOT_BE_ASSIGNED', @@ -20488,8 +20168,7 @@ export type ProductBulkCreateInput = { channelListings?: InputMaybe>; /** * Determine if taxes are being charged for the product. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to configure whether tax collection is enabled. + * @deprecated Use `Channel.taxConfiguration` to configure whether tax collection is enabled. */ chargeTaxes?: InputMaybe; /** List of IDs of collections that the product belongs to. */ @@ -20504,11 +20183,19 @@ export type ProductBulkCreateInput = { externalReference?: InputMaybe; /** List of media inputs associated with the product. */ media?: InputMaybe>; - /** Fields required to update the product metadata. */ + /** + * Fields required to update the product metadata. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ metadata?: InputMaybe>; /** Product name. */ name?: InputMaybe; - /** Fields required to update the product private metadata. */ + /** + * Fields required to update the product private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ privateMetadata?: InputMaybe>; /** ID of the type that product belongs to. */ productType: Scalars['ID']['input']; @@ -20522,8 +20209,7 @@ export type ProductBulkCreateInput = { taxClass?: InputMaybe; /** * Tax rate for enabled tax gateway. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use tax classes to control the tax calculation for a product. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned. + * @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. */ taxCode?: InputMaybe; /** Input list of product variants to create. */ @@ -20542,7 +20228,7 @@ export type ProductBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -20557,10 +20243,6 @@ export type ProductBulkResult = { /** * Creates/updates translations for products. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. * * Triggers the following webhook events: @@ -20608,13 +20290,9 @@ export type ProductBulkTranslateResult = { /** Represents product channel listing. */ export type ProductChannelListing = Node & { __typename?: 'ProductChannelListing'; - /** @deprecated This field will be removed in Saleor 4.0. Use the `availableForPurchaseAt` field to fetch the available for purchase date. */ + /** @deprecated Use the `availableForPurchaseAt` field to fetch the available for purchase date. */ availableForPurchase?: Maybe; - /** - * The product available for purchase date time. - * - * Added in Saleor 3.3. - */ + /** The product available for purchase date time. */ availableForPurchaseAt?: Maybe; /** The channel in which the product is listed. */ channel: Channel; @@ -20634,13 +20312,9 @@ export type ProductChannelListing = Node & { margin?: Maybe; /** Lists the storefront product's pricing, the current price and discounts, only meant for displaying. */ pricing?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use the `publishedAt` field to fetch the publication date. */ + /** @deprecated Use the `publishedAt` field to fetch the publication date. */ publicationDate?: Maybe; - /** - * The product publication date time. - * - * Added in Saleor 3.3. - */ + /** The product publication date time. */ publishedAt?: Maybe; /** * Purchase cost of product. @@ -20661,16 +20335,11 @@ export type ProductChannelListingPricingArgs = { export type ProductChannelListingAddInput = { /** List of variants to which the channel should be assigned. */ addVariants?: InputMaybe>; - /** - * A start date time from which a product will be available for purchase. When not set and `isAvailable` is set to True, the current day is assumed. - * - * Added in Saleor 3.3. - */ + /** 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?: 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: this field will be removed in Saleor 4.0. Use `availableForPurchaseAt` field instead. + * @deprecated Use `availableForPurchaseAt` field instead. */ availableForPurchaseDate?: InputMaybe; /** ID of a channel. */ @@ -20681,15 +20350,10 @@ export type ProductChannelListingAddInput = { isPublished?: InputMaybe; /** * Publication date. ISO 8601 standard. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead. + * @deprecated Use `publishedAt` field instead. */ publicationDate?: InputMaybe; - /** - * Publication date time. ISO 8601 standard. - * - * Added in Saleor 3.3. - */ + /** Publication date time. ISO 8601 standard. */ publishedAt?: InputMaybe; /** List of variants from which the channel should be unassigned. */ removeVariants?: InputMaybe>; @@ -20740,7 +20404,7 @@ export type ProductChannelListingUpdate = { errors: Array; /** An updated product instance. */ product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productChannelListingErrors: Array; }; @@ -20777,7 +20441,7 @@ export type ProductCreate = { __typename?: 'ProductCreate'; errors: Array; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -20788,8 +20452,7 @@ export type ProductCreateInput = { category?: InputMaybe; /** * Determine if taxes are being charged for the product. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to configure whether tax collection is enabled. + * @deprecated Use `Channel.taxConfiguration` to configure whether tax collection is enabled. */ chargeTaxes?: InputMaybe; /** List of IDs of collections that the product belongs to. */ @@ -20800,24 +20463,20 @@ export type ProductCreateInput = { * Rich text format. For reference see https://editorjs.io/ */ description?: InputMaybe; - /** - * External ID of this product. - * - * Added in Saleor 3.10. - */ + /** External ID of this product. */ externalReference?: InputMaybe; /** - * Fields required to update the product metadata. + * Fields required to update the product metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Product name. */ name?: InputMaybe; /** - * Fields required to update the product private metadata. + * Fields required to update the product private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** ID of the type that product belongs to. */ @@ -20832,19 +20491,14 @@ export type ProductCreateInput = { taxClass?: InputMaybe; /** * Tax rate for enabled tax gateway. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use tax classes to control the tax calculation for a product. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned. + * @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. */ taxCode?: InputMaybe; /** Weight of the Product. */ weight?: InputMaybe; }; -/** - * Event sent when new product is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new product is created. */ export type ProductCreated = Event & { __typename?: 'ProductCreated'; /** The category of the product. */ @@ -20862,11 +20516,7 @@ export type ProductCreated = Event & { }; -/** - * Event sent when new product is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new product is created. */ export type ProductCreatedProductArgs = { channel?: InputMaybe; }; @@ -20880,15 +20530,11 @@ export type ProductDelete = { __typename?: 'ProductDelete'; errors: Array; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; -/** - * Event sent when product is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when product is deleted. */ export type ProductDeleted = Event & { __typename?: 'ProductDeleted'; /** The category of the product. */ @@ -20906,11 +20552,7 @@ export type ProductDeleted = Event & { }; -/** - * Event sent when product is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when product is deleted. */ export type ProductDeletedProductArgs = { channel?: InputMaybe; }; @@ -20929,7 +20571,6 @@ export type ProductError = { values?: Maybe>; }; -/** An enumeration. */ export enum ProductErrorCode { AlreadyExists = 'ALREADY_EXISTS', AttributeAlreadyAssigned = 'ATTRIBUTE_ALREADY_ASSIGNED', @@ -20939,6 +20580,7 @@ export enum ProductErrorCode { DuplicatedInputItem = 'DUPLICATED_INPUT_ITEM', GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', + InvalidFileType = 'INVALID_FILE_TYPE', InvalidPrice = 'INVALID_PRICE', MediaAlreadyAssigned = 'MEDIA_ALREADY_ASSIGNED', NotFound = 'NOT_FOUND', @@ -20950,14 +20592,11 @@ export enum ProductErrorCode { Required = 'REQUIRED', Unique = 'UNIQUE', UnsupportedMediaProvider = 'UNSUPPORTED_MEDIA_PROVIDER', + UnsupportedMimeType = 'UNSUPPORTED_MIME_TYPE', VariantNoDigitalContent = 'VARIANT_NO_DIGITAL_CONTENT' } -/** - * Event sent when product export is completed. - * - * Added in Saleor 3.16. - */ +/** Event sent when product export is completed. */ export type ProductExportCompleted = Event & { __typename?: 'ProductExportCompleted'; /** The export file for products. */ @@ -20989,17 +20628,12 @@ export enum ProductFieldEnum { export type ProductFilterInput = { attributes?: InputMaybe>; - /** - * Filter by the date of availability for purchase. - * - * Added in Saleor 3.8. - */ + /** Filter by the date of availability for purchase. */ availableFrom?: InputMaybe; categories?: InputMaybe>; /** * Specifies the channel by which the data should be filtered. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. + * @deprecated Use root-level channel argument instead. */ channel?: InputMaybe; collections?: InputMaybe>; @@ -21008,29 +20642,17 @@ export type ProductFilterInput = { hasCategory?: InputMaybe; hasPreorderedVariants?: InputMaybe; ids?: InputMaybe>; - /** - * Filter by availability for purchase. - * - * Added in Saleor 3.8. - */ + /** Filter by availability for purchase. */ isAvailable?: InputMaybe; isPublished?: InputMaybe; - /** - * Filter by visibility in product listings. - * - * Added in Saleor 3.8. - */ + /** Filter by visibility in product listings. */ isVisibleInListing?: InputMaybe; metadata?: InputMaybe>; /** Filter by the lowest variant price after discounts. */ minimalPrice?: InputMaybe; price?: InputMaybe; productTypes?: InputMaybe>; - /** - * Filter by the publication date. - * - * Added in Saleor 3.8. - */ + /** Filter by the publication date. */ publishedFrom?: InputMaybe; search?: InputMaybe; slugs?: InputMaybe>; @@ -21068,8 +20690,7 @@ export type ProductInput = { category?: InputMaybe; /** * Determine if taxes are being charged for the product. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to configure whether tax collection is enabled. + * @deprecated Use `Channel.taxConfiguration` to configure whether tax collection is enabled. */ chargeTaxes?: InputMaybe; /** List of IDs of collections that the product belongs to. */ @@ -21080,24 +20701,20 @@ export type ProductInput = { * Rich text format. For reference see https://editorjs.io/ */ description?: InputMaybe; - /** - * External ID of this product. - * - * Added in Saleor 3.10. - */ + /** External ID of this product. */ externalReference?: InputMaybe; /** - * Fields required to update the product metadata. + * Fields required to update the product metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Product name. */ name?: InputMaybe; /** - * Fields required to update the product private metadata. + * Fields required to update the product private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** Defines the product rating value. */ @@ -21110,8 +20727,7 @@ export type ProductInput = { taxClass?: InputMaybe; /** * Tax rate for enabled tax gateway. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use tax classes to control the tax calculation for a product. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned. + * @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. */ taxCode?: InputMaybe; /** Weight of the Product. */ @@ -21125,53 +20741,29 @@ export type ProductMedia = Node & ObjectWithMetadata & { alt: Scalars['String']['output']; /** The unique ID of the product media. */ id: Scalars['ID']['output']; - /** - * List of public metadata items. Can be accessed without permissions. - * - * Added in Saleor 3.12. - */ + /** List of public metadata items. Can be accessed without permissions. */ metadata: Array; /** * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.12. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.12. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** The oEmbed data of the media. */ oembedData: Scalars['JSONString']['output']; - /** - * List of private metadata items. Requires staff permissions to access. - * - * Added in Saleor 3.12. - */ + /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; /** * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.12. */ 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. - * - * Added in Saleor 3.12. - */ - privateMetafields?: Maybe; - /** - * Product id the media refers to. - * - * Added in Saleor 3.12. - */ + /** 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; + /** Product id the media refers to. */ productId?: Maybe; /** The sort order of the media. */ sortOrder?: Maybe; @@ -21222,7 +20814,7 @@ export type ProductMediaBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -21236,7 +20828,7 @@ export type ProductMediaCreate = { errors: Array; media?: Maybe; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -21251,11 +20843,7 @@ export type ProductMediaCreateInput = { product: Scalars['ID']['input']; }; -/** - * Event sent when new product media is created. - * - * Added in Saleor 3.12. - */ +/** Event sent when new product media is created. */ export type ProductMediaCreated = Event & { __typename?: 'ProductMediaCreated'; /** Time of the event. */ @@ -21280,15 +20868,11 @@ export type ProductMediaDelete = { errors: Array; media?: Maybe; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; -/** - * Event sent when product media is deleted. - * - * Added in Saleor 3.12. - */ +/** Event sent when product media is deleted. */ export type ProductMediaDeleted = Event & { __typename?: 'ProductMediaDeleted'; /** Time of the event. */ @@ -21313,11 +20897,10 @@ export type ProductMediaReorder = { errors: Array; media?: Maybe>; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; -/** An enumeration. */ export enum ProductMediaType { Image = 'IMAGE', Video = 'VIDEO' @@ -21333,7 +20916,7 @@ export type ProductMediaUpdate = { errors: Array; media?: Maybe; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -21342,11 +20925,7 @@ export type ProductMediaUpdateInput = { alt?: InputMaybe; }; -/** - * Event sent when product media is updated. - * - * Added in Saleor 3.12. - */ +/** Event sent when product media is updated. */ export type ProductMediaUpdated = Event & { __typename?: 'ProductMediaUpdated'; /** Time of the event. */ @@ -21361,11 +20940,7 @@ export type ProductMediaUpdated = Event & { version?: Maybe; }; -/** - * Event sent when product metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when product metadata is updated. */ export type ProductMetadataUpdated = Event & { __typename?: 'ProductMetadataUpdated'; /** The category of the product. */ @@ -21383,11 +20958,7 @@ export type ProductMetadataUpdated = Event & { }; -/** - * Event sent when product metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when product metadata is updated. */ export type ProductMetadataUpdatedProductArgs = { channel?: InputMaybe; }; @@ -21400,8 +20971,7 @@ export type ProductOrder = { attributeId?: InputMaybe; /** * Specifies the channel in which to sort the data. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. + * @deprecated Use root-level channel argument instead. */ channel?: InputMaybe; /** Specifies the direction in which to sort products. */ @@ -21417,15 +20987,17 @@ export enum ProductOrderField { * This option requires a channel filter to work as the values can vary between channels. */ Collection = 'COLLECTION', + /** Sort products by creation date. */ + CreatedAt = 'CREATED_AT', /** - * Sort products by creation date. - * - * Added in Saleor 3.8. + * Sort products by update date. + * @deprecated Use `LAST_MODIFIED_AT` instead. */ - CreatedAt = 'CREATED_AT', - /** Sort products by update date. */ Date = 'DATE', - /** Sort products by update date. */ + /** + * Sort products by update date. + * @deprecated Use `LAST_MODIFIED_AT` instead. + */ LastModified = 'LAST_MODIFIED', /** Sort products by update date. */ LastModifiedAt = 'LAST_MODIFIED_AT', @@ -21447,6 +21019,7 @@ export enum ProductOrderField { * Sort products by publication date. * * This option requires a channel filter to work as the values can vary between channels. + * @deprecated Use `PUBLISHED_AT` instead. */ PublicationDate = 'PUBLICATION_DATE', /** @@ -21476,14 +21049,16 @@ export type ProductPricingInfo = { discount?: Maybe; /** * The discount amount in the local currency. - * @deprecated This field will be removed in Saleor 4.0. Always returns `null`. + * @deprecated Always returns `null`. */ discountLocalCurrency?: Maybe; /** - * Determines whether displayed prices should include taxes. + * 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.9. + * Added in Saleor 3.21. */ + discountPrior?: Maybe; + /** Determines whether displayed prices should include taxes. */ displayGrossPrices: Scalars['Boolean']['output']; /** Whether it is in sale or not. */ onSale?: Maybe; @@ -21491,9 +21066,15 @@ export type ProductPricingInfo = { priceRange?: Maybe; /** * The discounted price range of the product variants in the local currency. - * @deprecated This field will be removed in Saleor 4.0. Always returns `null`. + * @deprecated Always returns `null`. */ priceRangeLocalCurrency?: Maybe; + /** + * The prior price range of the product variants. + * + * Added in Saleor 3.21. + */ + priceRangePrior?: Maybe; /** The undiscounted price range of the product variants. */ priceRangeUndiscounted?: Maybe; }; @@ -21508,7 +21089,7 @@ export type ProductReorderAttributeValues = { errors: Array; /** Product from which attribute values are reordered. */ product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -21532,7 +21113,7 @@ export type ProductTranslatableContent = Node & { * Description of the product. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `description` field instead. + * @deprecated Use the `description` field instead. */ descriptionJson?: Maybe; /** The ID of the product translatable content. */ @@ -21541,19 +21122,21 @@ export type ProductTranslatableContent = Node & { name: Scalars['String']['output']; /** * Represents an individual item for sale in the storefront. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ product?: Maybe; - /** - * The ID of the product to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the product to translate. */ productId: Scalars['ID']['output']; /** SEO description to translate. */ seoDescription?: Maybe; /** SEO title to translate. */ seoTitle?: Maybe; + /** + * Slug to translate. + * + * Added in Saleor 3.21. + */ + slug?: Maybe; /** Returns translated product fields for the given language code. */ translation?: Maybe; }; @@ -21573,11 +21156,10 @@ export type ProductTranslate = { __typename?: 'ProductTranslate'; errors: Array; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; -/** An enumeration. */ export enum ProductTranslateErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', @@ -21598,7 +21180,7 @@ export type ProductTranslation = Node & { * Translated description of the product. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `description` field instead. + * @deprecated Use the `description` field instead. */ descriptionJson?: Maybe; /** The ID of the product translation. */ @@ -21612,21 +21194,19 @@ export type ProductTranslation = Node & { /** Translated SEO title. */ seoTitle?: Maybe; /** - * Represents the product fields to translate. + * Translated product slug. * - * Added in Saleor 3.14. + * Added in Saleor 3.21. */ + slug?: Maybe; + /** Represents the product fields to translate. */ translatableContent?: Maybe; }; /** Represents a type of product. It defines what attributes are available to products of this type. */ export type ProductType = Node & ObjectWithMetadata & { __typename?: 'ProductType'; - /** - * Variant attributes of that product type with attached variant selection. - * - * Added in Saleor 3.1. - */ + /** Variant attributes of that product type with attached variant selection. */ assignedVariantAttributes?: Maybe>; /** * List of attributes which can be assigned to this product type. @@ -21650,15 +21230,9 @@ export type ProductType = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Name of the product type. */ name: Scalars['String']['output']; @@ -21668,21 +21242,15 @@ export type ProductType = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** Product attributes of that product type. */ productAttributes?: Maybe>; /** * List of products of this type. - * @deprecated This field will be removed in Saleor 4.0. Use the top-level `products` query with the `productTypes` filter. + * @deprecated Use the top-level `products` query with the `productTypes` filter. */ products?: Maybe; /** Slug of the product type. */ @@ -21695,12 +21263,12 @@ export type ProductType = Node & ObjectWithMetadata & { taxClass?: Maybe; /** * A type of tax. Assigned by enabled tax gateway - * @deprecated This field will be removed in Saleor 4.0. Use `taxClass` field instead. + * @deprecated Use `taxClass` field instead. */ taxType?: Maybe; /** * Variant attributes of that product type. - * @deprecated This field will be removed in Saleor 4.0. Use `assignedVariantAttributes` instead. + * @deprecated Use `assignedVariantAttributes` instead. */ variantAttributes?: Maybe>; /** Weight of the product type. */ @@ -21721,6 +21289,7 @@ export type ProductTypeAvailableAttributesArgs = { filter?: InputMaybe; first?: InputMaybe; last?: InputMaybe; + search?: InputMaybe; where?: InputMaybe; }; @@ -21774,7 +21343,7 @@ export type ProductTypeBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -21808,7 +21377,7 @@ export type ProductTypeCountableEdge = { export type ProductTypeCreate = { __typename?: 'ProductTypeCreate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; productType?: Maybe; }; @@ -21821,7 +21390,7 @@ export type ProductTypeCreate = { export type ProductTypeDelete = { __typename?: 'ProductTypeDelete'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; productType?: Maybe; }; @@ -21860,8 +21429,7 @@ export type ProductTypeInput = { taxClass?: InputMaybe; /** * Tax rate for enabled tax gateway. - * - * DEPRECATED: this field will be removed in Saleor 4.0.. Use tax classes to control the tax calculation for a product type. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned. + * @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. */ taxCode?: InputMaybe; /** List of attributes used to distinguish between different variants of a product. */ @@ -21870,7 +21438,6 @@ export type ProductTypeInput = { weight?: InputMaybe; }; -/** An enumeration. */ export enum ProductTypeKindEnum { GiftCard = 'GIFT_CARD', Normal = 'NORMAL' @@ -21884,7 +21451,7 @@ export enum ProductTypeKindEnum { export type ProductTypeReorderAttributes = { __typename?: 'ProductTypeReorderAttributes'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; /** Product type from which attributes are reordered. */ productType?: Maybe; @@ -21914,7 +21481,7 @@ export type ProductTypeSortingInput = { export type ProductTypeUpdate = { __typename?: 'ProductTypeUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; productType?: Maybe; }; @@ -21928,15 +21495,11 @@ export type ProductUpdate = { __typename?: 'ProductUpdate'; errors: Array; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; -/** - * Event sent when product is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when product is updated. */ export type ProductUpdated = Event & { __typename?: 'ProductUpdated'; /** The category of the product. */ @@ -21954,19 +21517,30 @@ export type ProductUpdated = Event & { }; -/** - * Event sent when product is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when product is updated. */ export type ProductUpdatedProductArgs = { channel?: InputMaybe; }; /** Represents a version of a product such as different size or color. */ -export type ProductVariant = Node & ObjectWithMetadata & { +export type ProductVariant = Node & ObjectWithAttributes & ObjectWithMetadata & { __typename?: 'ProductVariant'; - /** List of attributes assigned to this variant. */ + /** + * Get a single attribute attached to product by attribute slug. + * + * Added in Saleor 3.22. + */ + assignedAttribute?: Maybe; + /** + * List of attributes assigned to this variant. + * + * Added in Saleor 3.22. + */ + assignedAttributes: Array; + /** + * List of attributes assigned to this variant. + * @deprecated Use the `assignedAttributes` field instead. + */ attributes: Array; /** Channel given to retrieve this product variant. Also used by federation gateway to resolve this object in a federated query. */ channel?: Maybe; @@ -21984,17 +21558,13 @@ export type ProductVariant = Node & ObjectWithMetadata & { * Requires one of the following permissions: MANAGE_PRODUCTS. */ digitalContent?: Maybe; - /** - * External ID of this product. - * - * Added in Saleor 3.10. - */ + /** External ID of this product. */ externalReference?: Maybe; /** The ID of the product variant. */ id: Scalars['ID']['output']; /** * List of images for the product variant. - * @deprecated This field will be removed in Saleor 4.0. Use the `media` field instead. + * @deprecated Use the `media` field instead. */ images?: Maybe>; /** Gross margin percentage value. */ @@ -22007,23 +21577,13 @@ export type ProductVariant = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** The name of the product variant. */ name: Scalars['String']['output']; - /** - * Preorder data for product variant. - * - * Added in Saleor 3.1. - */ + /** Preorder data for product variant. */ preorder?: Maybe; /** Lists the storefront variant's pricing, the current price and discounts, only meant for displaying. */ pricing?: Maybe; @@ -22033,15 +21593,9 @@ export type ProductVariant = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** The product to which the variant belongs. */ product: Product; @@ -22080,6 +21634,18 @@ export type ProductVariant = Node & ObjectWithMetadata & { }; +/** Represents a version of a product such as different size or color. */ +export type ProductVariantAssignedAttributeArgs = { + slug: Scalars['String']['input']; +}; + + +/** Represents a version of a product such as different size or color. */ +export type ProductVariantAssignedAttributesArgs = { + limit?: InputMaybe; +}; + + /** Represents a version of a product such as different size or color. */ export type ProductVariantAttributesArgs = { variantSelection?: InputMaybe; @@ -22141,11 +21707,7 @@ export type ProductVariantTranslationArgs = { languageCode: LanguageCodeEnum; }; -/** - * Event sent when product variant is back in stock. - * - * Added in Saleor 3.2. - */ +/** Event sent when product variant is back in stock. */ export type ProductVariantBackInStock = Event & { __typename?: 'ProductVariantBackInStock'; /** Time of the event. */ @@ -22163,11 +21725,7 @@ export type ProductVariantBackInStock = Event & { }; -/** - * Event sent when product variant is back in stock. - * - * Added in Saleor 3.2. - */ +/** Event sent when product variant is back in stock. */ export type ProductVariantBackInStockProductVariantArgs = { channel?: InputMaybe; }; @@ -22179,18 +21737,14 @@ export type ProductVariantBackInStockProductVariantArgs = { */ export type ProductVariantBulkCreate = { __typename?: 'ProductVariantBulkCreate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ bulkProductErrors: Array; /** Returns how many objects were created. */ count: Scalars['Int']['output']; errors: Array; - /** List of the created variants.This field will be removed in Saleor 4.0. */ + /** List of the created variants. */ productVariants: Array; - /** - * List of the created variants. - * - * Added in Saleor 3.11. - */ + /** List of the created variants. */ results: Array; }; @@ -22199,37 +21753,25 @@ export type ProductVariantBulkCreateInput = { attributes: Array; /** List of prices assigned to channels. */ channelListings?: InputMaybe>; - /** - * External ID of this product variant. - * - * Added in Saleor 3.10. - */ + /** External ID of this product variant. */ externalReference?: InputMaybe; /** - * Fields required to update the product variant metadata. + * Fields required to update the product variant metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Variant name. */ name?: InputMaybe; - /** - * Determines if variant is in preorder. - * - * Added in Saleor 3.1. - */ + /** Determines if variant is in preorder. */ preorder?: InputMaybe; /** - * Fields required to update the product variant private metadata. + * Fields required to update the product variant private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; - /** - * Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. - * - * Added in Saleor 3.1. - */ + /** Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. */ quantityLimitPerCustomer?: InputMaybe; /** Stock keeping unit. */ sku?: InputMaybe; @@ -22251,7 +21793,7 @@ export type ProductVariantBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -22261,11 +21803,7 @@ export type ProductVariantBulkError = { attributes?: Maybe>; /** List of channel listings IDs which causes the error. */ channelListings?: Maybe>; - /** - * List of channel IDs which causes the error. - * - * Added in Saleor 3.12. - */ + /** List of channel IDs which causes the error. */ channels?: Maybe>; /** The error code. */ code: ProductVariantBulkErrorCode; @@ -22273,17 +21811,9 @@ export type ProductVariantBulkError = { field?: Maybe; /** The error message. */ message?: Maybe; - /** - * Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. - * - * Added in Saleor 3.14. - */ + /** Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ path?: Maybe; - /** - * List of stocks IDs which causes the error. - * - * Added in Saleor 3.12. - */ + /** List of stocks IDs which causes the error. */ stocks?: Maybe>; /** List of attribute values IDs which causes the error. */ values?: Maybe>; @@ -22291,7 +21821,6 @@ export type ProductVariantBulkError = { warehouses?: Maybe>; }; -/** An enumeration. */ export enum ProductVariantBulkErrorCode { AttributeAlreadyAssigned = 'ATTRIBUTE_ALREADY_ASSIGNED', AttributeCannotBeAssigned = 'ATTRIBUTE_CANNOT_BE_ASSIGNED', @@ -22317,11 +21846,7 @@ export type ProductVariantBulkResult = { }; /** - * Creates/updates translations for products variants. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Creates/updates translations for product variants. * * Requires one of the following permissions: MANAGE_TRANSLATIONS. * @@ -22368,11 +21893,7 @@ export type ProductVariantBulkTranslateResult = { }; /** - * Update multiple product variants. - * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Updates multiple product variants. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ @@ -22385,65 +21906,37 @@ export type ProductVariantBulkUpdate = { results: Array; }; -/** - * Input fields to update product variants. - * - * Added in Saleor 3.11. - */ +/** Input fields to update product variants. */ export type ProductVariantBulkUpdateInput = { /** List of attributes specific to this variant. */ attributes?: InputMaybe>; - /** - * Channel listings input. - * - * Added in Saleor 3.12. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Channel listings input. */ channelListings?: InputMaybe; - /** - * External ID of this product variant. - * - * Added in Saleor 3.10. - */ + /** External ID of this product variant. */ externalReference?: InputMaybe; /** ID of the product variant to update. */ id: Scalars['ID']['input']; /** - * Fields required to update the product variant metadata. + * Fields required to update the product variant metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Variant name. */ name?: InputMaybe; - /** - * Determines if variant is in preorder. - * - * Added in Saleor 3.1. - */ + /** Determines if variant is in preorder. */ preorder?: InputMaybe; /** - * Fields required to update the product variant private metadata. + * Fields required to update the product variant private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; - /** - * Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. - * - * Added in Saleor 3.1. - */ + /** Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. */ quantityLimitPerCustomer?: InputMaybe; /** Stock keeping unit. */ sku?: InputMaybe; - /** - * Stocks input. - * - * Added in Saleor 3.12. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Stocks input. */ stocks?: InputMaybe; /** 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?: InputMaybe; @@ -22466,14 +21959,16 @@ export type ProductVariantChannelListing = Node & { * Requires one of the following permissions: MANAGE_PRODUCTS. */ margin?: Maybe; - /** - * Preorder variant data. - * - * Added in Saleor 3.1. - */ + /** Preorder variant data. */ preorderThreshold?: Maybe; /** The price of the variant. */ price?: Maybe; + /** + * Prior price of the variant used for discount calculations. + * + * Added in Saleor 3.21. + */ + priorPrice?: Maybe; }; export type ProductVariantChannelListingAddInput = { @@ -22481,14 +21976,16 @@ export type ProductVariantChannelListingAddInput = { channelId: Scalars['ID']['input']; /** Cost price of the variant in channel. */ costPrice?: InputMaybe; - /** - * The threshold for preorder variant in channel. - * - * Added in Saleor 3.1. - */ + /** The threshold for preorder variant in channel. */ preorderThreshold?: InputMaybe; /** Price of the particular variant in channel. */ price: Scalars['PositiveDecimal']['input']; + /** + * Previous price of the variant in channel. Useful for providing promotion information required by customer protection laws such as EU Omnibus directive. + * + * Added in Saleor 3.21. + */ + priorPrice?: InputMaybe; }; /** @@ -22499,7 +21996,7 @@ export type ProductVariantChannelListingAddInput = { export type ProductVariantChannelListingUpdate = { __typename?: 'ProductVariantChannelListingUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productChannelListingErrors: Array; /** An updated product variant instance. */ variant?: Maybe; @@ -22539,7 +22036,7 @@ export type ProductVariantCountableEdge = { export type ProductVariantCreate = { __typename?: 'ProductVariantCreate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; productVariant?: Maybe; }; @@ -22547,39 +22044,27 @@ export type ProductVariantCreate = { export type ProductVariantCreateInput = { /** List of attributes specific to this variant. */ attributes: Array; - /** - * External ID of this product variant. - * - * Added in Saleor 3.10. - */ + /** External ID of this product variant. */ externalReference?: InputMaybe; /** - * Fields required to update the product variant metadata. + * Fields required to update the product variant metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Variant name. */ name?: InputMaybe; - /** - * Determines if variant is in preorder. - * - * Added in Saleor 3.1. - */ + /** Determines if variant is in preorder. */ preorder?: InputMaybe; /** - * Fields required to update the product variant private metadata. + * Fields required to update the product variant private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** Product ID of which type is the variant. */ product: Scalars['ID']['input']; - /** - * Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. - * - * Added in Saleor 3.1. - */ + /** Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. */ quantityLimitPerCustomer?: InputMaybe; /** Stock keeping unit. */ sku?: InputMaybe; @@ -22591,11 +22076,7 @@ export type ProductVariantCreateInput = { weight?: InputMaybe; }; -/** - * Event sent when new product variant is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new product variant is created. */ export type ProductVariantCreated = Event & { __typename?: 'ProductVariantCreated'; /** Time of the event. */ @@ -22611,11 +22092,7 @@ export type ProductVariantCreated = Event & { }; -/** - * Event sent when new product variant is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new product variant is created. */ export type ProductVariantCreatedProductVariantArgs = { channel?: InputMaybe; }; @@ -22628,16 +22105,12 @@ export type ProductVariantCreatedProductVariantArgs = { export type ProductVariantDelete = { __typename?: 'ProductVariantDelete'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; productVariant?: Maybe; }; -/** - * Event sent when product variant is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when product variant is deleted. */ export type ProductVariantDeleted = Event & { __typename?: 'ProductVariantDeleted'; /** Time of the event. */ @@ -22653,11 +22126,7 @@ export type ProductVariantDeleted = Event & { }; -/** - * Event sent when product variant is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when product variant is deleted. */ export type ProductVariantDeletedProductVariantArgs = { channel?: InputMaybe; }; @@ -22673,37 +22142,25 @@ export type ProductVariantFilterInput = { export type ProductVariantInput = { /** List of attributes specific to this variant. */ attributes?: InputMaybe>; - /** - * External ID of this product variant. - * - * Added in Saleor 3.10. - */ + /** External ID of this product variant. */ externalReference?: InputMaybe; /** - * Fields required to update the product variant metadata. + * Fields required to update the product variant metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Variant name. */ name?: InputMaybe; - /** - * Determines if variant is in preorder. - * - * Added in Saleor 3.1. - */ + /** Determines if variant is in preorder. */ preorder?: InputMaybe; /** - * Fields required to update the product variant private metadata. + * Fields required to update the product variant private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; - /** - * Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. - * - * Added in Saleor 3.1. - */ + /** Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. */ quantityLimitPerCustomer?: InputMaybe; /** Stock keeping unit. */ sku?: InputMaybe; @@ -22713,11 +22170,7 @@ export type ProductVariantInput = { weight?: InputMaybe; }; -/** - * Event sent when product variant metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when product variant metadata is updated. */ export type ProductVariantMetadataUpdated = Event & { __typename?: 'ProductVariantMetadataUpdated'; /** Time of the event. */ @@ -22733,20 +22186,12 @@ export type ProductVariantMetadataUpdated = Event & { }; -/** - * Event sent when product variant metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when product variant metadata is updated. */ export type ProductVariantMetadataUpdatedProductVariantArgs = { channel?: InputMaybe; }; -/** - * Event sent when product variant is out of stock. - * - * Added in Saleor 3.2. - */ +/** Event sent when product variant is out of stock. */ export type ProductVariantOutOfStock = Event & { __typename?: 'ProductVariantOutOfStock'; /** Time of the event. */ @@ -22764,11 +22209,7 @@ export type ProductVariantOutOfStock = Event & { }; -/** - * Event sent when product variant is out of stock. - * - * Added in Saleor 3.2. - */ +/** Event sent when product variant is out of stock. */ export type ProductVariantOutOfStockProductVariantArgs = { channel?: InputMaybe; }; @@ -22776,8 +22217,6 @@ export type ProductVariantOutOfStockProductVariantArgs = { /** * Deactivates product variant preorder. It changes all preorder allocation into regular allocation. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_PRODUCTS. */ export type ProductVariantPreorderDeactivate = { @@ -22796,7 +22235,7 @@ export type ProductVariantReorder = { __typename?: 'ProductVariantReorder'; errors: Array; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -22808,7 +22247,7 @@ export type ProductVariantReorder = { export type ProductVariantReorderAttributeValues = { __typename?: 'ProductVariantReorderAttributeValues'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; /** Product variant from which attribute values are reordered. */ productVariant?: Maybe; @@ -22823,12 +22262,12 @@ export type ProductVariantSetDefault = { __typename?: 'ProductVariantSetDefault'; errors: Array; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; export enum ProductVariantSortField { - /** Sort products variants by last modified at. */ + /** Sort product variants by last modification date. */ LastModifiedAt = 'LAST_MODIFIED_AT' } @@ -22839,13 +22278,7 @@ export type ProductVariantSortingInput = { field: ProductVariantSortField; }; -/** - * Event sent when product variant stock is updated. - * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when product variant stock is updated. */ export type ProductVariantStockUpdated = Event & { __typename?: 'ProductVariantStockUpdated'; /** Time of the event. */ @@ -22863,13 +22296,7 @@ export type ProductVariantStockUpdated = Event & { }; -/** - * Event sent when product variant stock is updated. - * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when product variant stock is updated. */ export type ProductVariantStockUpdatedProductVariantArgs = { channel?: InputMaybe; }; @@ -22881,7 +22308,7 @@ export type ProductVariantStockUpdatedProductVariantArgs = { */ export type ProductVariantStocksCreate = { __typename?: 'ProductVariantStocksCreate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ bulkStockErrors: Array; errors: Array; /** Updated product variant. */ @@ -22889,7 +22316,7 @@ export type ProductVariantStocksCreate = { }; /** - * Delete stocks from product variant. + * Deletes stocks from product variant. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ @@ -22898,18 +22325,18 @@ export type ProductVariantStocksDelete = { errors: Array; /** Updated product variant. */ productVariant?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ stockErrors: Array; }; /** - * Update stocks for product variant. + * Updates stocks for product variant. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ export type ProductVariantStocksUpdate = { __typename?: 'ProductVariantStocksUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ bulkStockErrors: Array; errors: Array; /** Updated product variant. */ @@ -22936,14 +22363,10 @@ export type ProductVariantTranslatableContent = Node & { name: Scalars['String']['output']; /** * Represents a version of a product such as different size or color. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ productVariant?: Maybe; - /** - * The ID of the product variant to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the product variant to translate. */ productVariantId: Scalars['ID']['output']; /** Returns translated product variant fields for the given language code. */ translation?: Maybe; @@ -22964,11 +22387,10 @@ export type ProductVariantTranslate = { __typename?: 'ProductVariantTranslate'; errors: Array; productVariant?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; -/** An enumeration. */ export enum ProductVariantTranslateErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', @@ -22985,11 +22407,7 @@ export type ProductVariantTranslation = Node & { language: LanguageDisplay; /** Translated product variant name. */ name: Scalars['String']['output']; - /** - * Represents the product variant fields to translate. - * - * Added in Saleor 3.14. - */ + /** Represents the product variant fields to translate. */ translatableContent?: Maybe; }; @@ -23001,16 +22419,12 @@ export type ProductVariantTranslation = Node & { export type ProductVariantUpdate = { __typename?: 'ProductVariantUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; productVariant?: Maybe; }; -/** - * Event sent when product variant is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when product variant is updated. */ export type ProductVariantUpdated = Event & { __typename?: 'ProductVariantUpdated'; /** Time of the event. */ @@ -23026,11 +22440,7 @@ export type ProductVariantUpdated = Event & { }; -/** - * Event sent when product variant is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when product variant is updated. */ export type ProductVariantUpdatedProductVariantArgs = { channel?: InputMaybe; }; @@ -23040,8 +22450,18 @@ export type ProductVariantWhereInput = { AND?: InputMaybe>; /** A list of conditions of which at least one must be met. */ OR?: InputMaybe>; + /** + * Filter by attributes associated with the variant. + * + * Added in Saleor 3.22. + */ + attributes?: InputMaybe>; ids?: InputMaybe>; metadata?: InputMaybe>; + /** Filter by product SKU. */ + sku?: InputMaybe; + /** Filter by when was the most recent update. */ + updatedAt?: InputMaybe; }; export type ProductWhereInput = { @@ -23091,13 +22511,7 @@ export type ProductWhereInput = { updatedAt?: InputMaybe; }; -/** - * Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. */ export type Promotion = Node & ObjectWithMetadata & { __typename?: 'Promotion'; /** Date time of promotion creation. */ @@ -23115,15 +22529,9 @@ export type Promotion = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Name of the promotion. */ name: Scalars['String']['output']; @@ -23133,15 +22541,9 @@ export type Promotion = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** The list of promotion rules. */ rules?: Maybe>; @@ -23158,65 +22560,35 @@ export type Promotion = Node & ObjectWithMetadata & { */ type?: Maybe; /** Date time of last update of promotion. */ - updatedAt: Scalars['DateTime']['output']; -}; - - -/** - * Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + updatedAt: Scalars['DateTime']['output']; +}; + + +/** Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. */ export type PromotionMetafieldArgs = { key: Scalars['String']['input']; }; -/** - * Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. */ export type PromotionMetafieldsArgs = { keys?: InputMaybe>; }; -/** - * Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. */ export type PromotionPrivateMetafieldArgs = { key: Scalars['String']['input']; }; -/** - * Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. */ export type PromotionPrivateMetafieldsArgs = { keys?: InputMaybe>; }; -/** - * Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. */ export type PromotionTranslationArgs = { languageCode: LanguageCodeEnum; }; @@ -23224,10 +22596,6 @@ export type PromotionTranslationArgs = { /** * Deletes promotions. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -23260,10 +22628,6 @@ export type PromotionCountableEdge = { /** * Creates a new promotion. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -23296,7 +22660,6 @@ export type PromotionCreateError = { rulesLimitExceedBy?: Maybe; }; -/** An enumeration. */ export enum PromotionCreateErrorCode { GiftsNumberLimit = 'GIFTS_NUMBER_LIMIT', GraphqlError = 'GRAPHQL_ERROR', @@ -23329,13 +22692,7 @@ export type PromotionCreateInput = { type: PromotionTypeEnum; }; -/** - * Event sent when new promotion is created. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when new promotion is created. */ export type PromotionCreated = Event & { __typename?: 'PromotionCreated'; /** Time of the event. */ @@ -23350,13 +22707,7 @@ export type PromotionCreated = Event & { version?: Maybe; }; -/** - * History log of the promotion created event. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** History log of the promotion created event. */ export type PromotionCreatedEvent = Node & PromotionEventInterface & { __typename?: 'PromotionCreatedEvent'; /** @@ -23375,10 +22726,6 @@ export type PromotionCreatedEvent = Node & PromotionEventInterface & { /** * Deletes a promotion. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -23400,19 +22747,12 @@ export type PromotionDeleteError = { message?: Maybe; }; -/** An enumeration. */ export enum PromotionDeleteErrorCode { GraphqlError = 'GRAPHQL_ERROR', NotFound = 'NOT_FOUND' } -/** - * Event sent when promotion is deleted. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when promotion is deleted. */ export type PromotionDeleted = Event & { __typename?: 'PromotionDeleted'; /** Time of the event. */ @@ -23427,13 +22767,7 @@ export type PromotionDeleted = Event & { version?: Maybe; }; -/** - * The event informs about the end of the promotion. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** The event informs about the end of the promotion. */ export type PromotionEnded = Event & { __typename?: 'PromotionEnded'; /** Time of the event. */ @@ -23448,13 +22782,7 @@ export type PromotionEnded = Event & { version?: Maybe; }; -/** - * History log of the promotion ended event. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** History log of the promotion ended event. */ export type PromotionEndedEvent = Node & PromotionEventInterface & { __typename?: 'PromotionEndedEvent'; /** @@ -23486,7 +22814,6 @@ export type PromotionEventInterface = { type: PromotionEventsEnum; }; -/** An enumeration. */ export enum PromotionEventsEnum { PromotionCreated = 'PROMOTION_CREATED', PromotionEnded = 'PROMOTION_ENDED', @@ -23497,13 +22824,7 @@ export enum PromotionEventsEnum { RuleUpdated = 'RULE_UPDATED' } -/** - * Represents the promotion rule that specifies the conditions that must be met to apply the promotion discount. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the promotion rule that specifies the conditions that must be met to apply the promotion discount. */ export type PromotionRule = Node & { __typename?: 'PromotionRule'; /** The catalogue predicate that must be met to apply the rule reward. */ @@ -23576,13 +22897,7 @@ export type PromotionRule = Node & { }; -/** - * Represents the promotion rule that specifies the conditions that must be met to apply the promotion discount. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the promotion rule that specifies the conditions that must be met to apply the promotion discount. */ export type PromotionRuleTranslationArgs = { languageCode: LanguageCodeEnum; }; @@ -23590,10 +22905,6 @@ export type PromotionRuleTranslationArgs = { /** * Creates a new promotion rule. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -23623,7 +22934,6 @@ export type PromotionRuleCreateError = { rulesLimitExceedBy?: Maybe; }; -/** An enumeration. */ export enum PromotionRuleCreateErrorCode { GiftsNumberLimit = 'GIFTS_NUMBER_LIMIT', GraphqlError = 'GRAPHQL_ERROR', @@ -23678,13 +22988,7 @@ export type PromotionRuleCreateInput = { rewardValueType?: InputMaybe; }; -/** - * Event sent when new promotion rule is created. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when new promotion rule is created. */ export type PromotionRuleCreated = Event & { __typename?: 'PromotionRuleCreated'; /** Time of the event. */ @@ -23699,13 +23003,7 @@ export type PromotionRuleCreated = Event & { version?: Maybe; }; -/** - * History log of the promotion rule created event. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** History log of the promotion rule created event. */ export type PromotionRuleCreatedEvent = Node & PromotionEventInterface & PromotionRuleEventInterface & { __typename?: 'PromotionRuleCreatedEvent'; /** @@ -23726,10 +23024,6 @@ export type PromotionRuleCreatedEvent = Node & PromotionEventInterface & Promoti /** * Deletes a promotion rule. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -23751,19 +23045,12 @@ export type PromotionRuleDeleteError = { message?: Maybe; }; -/** An enumeration. */ export enum PromotionRuleDeleteErrorCode { GraphqlError = 'GRAPHQL_ERROR', NotFound = 'NOT_FOUND' } -/** - * Event sent when new promotion rule is deleted. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when new promotion rule is deleted. */ export type PromotionRuleDeleted = Event & { __typename?: 'PromotionRuleDeleted'; /** Time of the event. */ @@ -23778,13 +23065,7 @@ export type PromotionRuleDeleted = Event & { version?: Maybe; }; -/** - * History log of the promotion rule created event. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** History log of the promotion rule created event. */ export type PromotionRuleDeletedEvent = Node & PromotionEventInterface & PromotionRuleEventInterface & { __typename?: 'PromotionRuleDeletedEvent'; /** @@ -23802,13 +23083,7 @@ export type PromotionRuleDeletedEvent = Node & PromotionEventInterface & Promoti type: PromotionEventsEnum; }; -/** - * History log of the promotion event related to rule. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** History log of the promotion event related to rule. */ export type PromotionRuleEventInterface = { /** The rule ID associated with the promotion event. */ ruleId?: Maybe; @@ -23853,11 +23128,7 @@ export type PromotionRuleInput = { rewardValueType?: InputMaybe; }; -/** - * Represents promotion rule's original translatable fields and related translations. - * - * Added in Saleor 3.17. - */ +/** Represents promotion rule's original translatable fields and related translations. */ export type PromotionRuleTranslatableContent = Node & { __typename?: 'PromotionRuleTranslatableContent'; /** @@ -23870,22 +23141,14 @@ export type PromotionRuleTranslatableContent = Node & { id: Scalars['ID']['output']; /** Name of the promotion rule. */ name?: Maybe; - /** - * ID of the promotion rule to translate. - * - * Added in Saleor 3.14. - */ + /** ID of the promotion rule to translate. */ promotionRuleId: Scalars['ID']['output']; /** Returns translated promotion rule fields for the given language code. */ translation?: Maybe; }; -/** - * Represents promotion rule's original translatable fields and related translations. - * - * Added in Saleor 3.17. - */ +/** Represents promotion rule's original translatable fields and related translations. */ export type PromotionRuleTranslatableContentTranslationArgs = { languageCode: LanguageCodeEnum; }; @@ -23893,8 +23156,6 @@ export type PromotionRuleTranslatableContentTranslationArgs = { /** * Creates/updates translations for a promotion rule. * - * Added in Saleor 3.17. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. */ export type PromotionRuleTranslate = { @@ -23903,11 +23164,7 @@ export type PromotionRuleTranslate = { promotionRule?: Maybe; }; -/** - * Represents promotion rule translations. - * - * Added in Saleor 3.17. - */ +/** Represents promotion rule translations. */ export type PromotionRuleTranslation = Node & { __typename?: 'PromotionRuleTranslation'; /** @@ -23922,11 +23179,7 @@ export type PromotionRuleTranslation = Node & { language: LanguageDisplay; /** Translated name of the promotion rule. */ name?: Maybe; - /** - * Represents the promotion rule fields to translate. - * - * Added in Saleor 3.14. - */ + /** Represents the promotion rule fields to translate. */ translatableContent?: Maybe; }; @@ -23943,10 +23196,6 @@ export type PromotionRuleTranslationInput = { /** * Updates an existing promotion rule. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -23974,7 +23223,6 @@ export type PromotionRuleUpdateError = { message?: Maybe; }; -/** An enumeration. */ export enum PromotionRuleUpdateErrorCode { DuplicatedInputItem = 'DUPLICATED_INPUT_ITEM', GiftsNumberLimit = 'GIFTS_NUMBER_LIMIT', @@ -24037,13 +23285,7 @@ export type PromotionRuleUpdateInput = { rewardValueType?: InputMaybe; }; -/** - * Event sent when new promotion rule is updated. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when new promotion rule is updated. */ export type PromotionRuleUpdated = Event & { __typename?: 'PromotionRuleUpdated'; /** Time of the event. */ @@ -24058,13 +23300,7 @@ export type PromotionRuleUpdated = Event & { version?: Maybe; }; -/** - * History log of the promotion rule created event. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** History log of the promotion rule created event. */ export type PromotionRuleUpdatedEvent = Node & PromotionEventInterface & PromotionRuleEventInterface & { __typename?: 'PromotionRuleUpdatedEvent'; /** @@ -24083,7 +23319,7 @@ export type PromotionRuleUpdatedEvent = Node & PromotionEventInterface & Promoti }; export enum PromotionSortField { - /** Sort promotions by created at. */ + /** Sort promotions by creation date. */ CreatedAt = 'CREATED_AT', /** Sort promotions by end date. */ EndDate = 'END_DATE', @@ -24100,13 +23336,7 @@ export type PromotionSortingInput = { field: PromotionSortField; }; -/** - * The event informs about the start of the promotion. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** The event informs about the start of the promotion. */ export type PromotionStarted = Event & { __typename?: 'PromotionStarted'; /** Time of the event. */ @@ -24121,13 +23351,7 @@ export type PromotionStarted = Event & { version?: Maybe; }; -/** - * History log of the promotion started event. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** History log of the promotion started event. */ export type PromotionStartedEvent = Node & PromotionEventInterface & { __typename?: 'PromotionStartedEvent'; /** @@ -24143,11 +23367,7 @@ export type PromotionStartedEvent = Node & PromotionEventInterface & { type: PromotionEventsEnum; }; -/** - * Represents promotion's original translatable fields and related translations. - * - * Added in Saleor 3.17. - */ +/** Represents promotion's original translatable fields and related translations. */ export type PromotionTranslatableContent = Node & { __typename?: 'PromotionTranslatableContent'; /** @@ -24167,11 +23387,7 @@ export type PromotionTranslatableContent = Node & { }; -/** - * Represents promotion's original translatable fields and related translations. - * - * Added in Saleor 3.17. - */ +/** Represents promotion's original translatable fields and related translations. */ export type PromotionTranslatableContentTranslationArgs = { languageCode: LanguageCodeEnum; }; @@ -24179,8 +23395,6 @@ export type PromotionTranslatableContentTranslationArgs = { /** * Creates/updates translations for a promotion. * - * Added in Saleor 3.17. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. */ export type PromotionTranslate = { @@ -24189,11 +23403,7 @@ export type PromotionTranslate = { promotion?: Maybe; }; -/** - * Represents promotion translations. - * - * Added in Saleor 3.17. - */ +/** Represents promotion translations. */ export type PromotionTranslation = Node & { __typename?: 'PromotionTranslation'; /** @@ -24208,11 +23418,7 @@ export type PromotionTranslation = Node & { language: LanguageDisplay; /** Translated name of the promotion. */ name?: Maybe; - /** - * Represents the promotion fields to translate. - * - * Added in Saleor 3.14. - */ + /** Represents the promotion fields to translate. */ translatableContent?: Maybe; }; @@ -24226,7 +23432,6 @@ export type PromotionTranslationInput = { name?: InputMaybe; }; -/** An enumeration. */ export enum PromotionTypeEnum { Catalogue = 'CATALOGUE', Order = 'ORDER' @@ -24242,10 +23447,6 @@ export type PromotionTypeEnumFilterInput = { /** * Updates an existing promotion. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -24269,7 +23470,6 @@ export type PromotionUpdateError = { message?: Maybe; }; -/** An enumeration. */ export enum PromotionUpdateErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', @@ -24288,13 +23488,7 @@ export type PromotionUpdateInput = { startDate?: InputMaybe; }; -/** - * Event sent when promotion is updated. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when promotion is updated. */ export type PromotionUpdated = Event & { __typename?: 'PromotionUpdated'; /** Time of the event. */ @@ -24309,13 +23503,7 @@ export type PromotionUpdated = Event & { version?: Maybe; }; -/** - * History log of the promotion updated event. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** History log of the promotion updated event. */ export type PromotionUpdatedEvent = Node & PromotionEventInterface & { __typename?: 'PromotionUpdatedEvent'; /** @@ -24355,15 +23543,10 @@ export type PublishableChannelListingInput = { isPublished?: InputMaybe; /** * Publication date. ISO 8601 standard. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead. + * @deprecated Use `publishedAt` field instead. */ publicationDate?: InputMaybe; - /** - * Publication date time. ISO 8601 standard. - * - * Added in Saleor 3.3. - */ + /** Publication date time. ISO 8601 standard. */ publishedAt?: InputMaybe; }; @@ -24388,16 +23571,12 @@ export type Query = { /** * Look up an app extension by ID. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */ appExtension?: Maybe; /** * List of all extensions. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */ appExtensions?: Maybe; @@ -24436,18 +23615,18 @@ export type Query = { */ checkout?: Maybe; /** - * List of checkout lines. + * 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. * * Requires one of the following permissions: MANAGE_CHECKOUTS. */ checkoutLines?: Maybe; /** - * List of checkouts. + * 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. * * Requires one of the following permissions: MANAGE_CHECKOUTS, HANDLE_PAYMENTS. */ checkouts?: Maybe; - /** Look up a collection by ID. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. */ + /** 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. */ collection?: Maybe; /** List of the shop's collections. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. */ collections?: Maybe; @@ -24470,7 +23649,7 @@ export type Query = { */ digitalContents?: Maybe; /** - * List of draft orders. + * List of draft 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_ORDERS. */ @@ -24496,8 +23675,6 @@ export type Query = { /** * List of gift card currencies. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. */ giftCardCurrencies: Array; @@ -24510,8 +23687,6 @@ export type Query = { /** * List of gift card tags. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. */ giftCardTags?: Maybe; @@ -24525,7 +23700,7 @@ export type Query = { * List of activity events to display on homepage (at the moment it only contains order-events). * * Requires one of the following permissions: MANAGE_ORDERS. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ homepageEvents?: Maybe; /** Return the currently authenticated user. */ @@ -24542,18 +23717,18 @@ export type Query = { order?: Maybe; /** * Look up an order by token. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ orderByToken?: Maybe; /** * Order related settings from site settings. Returns `orderSettings` for the first `channel` in alphabetical order. * * Requires one of the following permissions: MANAGE_ORDERS. - * @deprecated This field will be removed in Saleor 4.0. Use the `channel` query to fetch the `orderSettings` field instead. + * @deprecated Use the `channel` query to fetch the `orderSettings` field instead. */ orderSettings?: Maybe; /** - * List of orders. + * List of 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_ORDERS. */ @@ -24562,7 +23737,7 @@ export type Query = { * Return the total sales amount from a specific period. * * Requires one of the following permissions: MANAGE_ORDERS. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ ordersTotal?: Maybe; /** Look up a page by ID or slug. */ @@ -24624,42 +23799,36 @@ export type Query = { /** * Look up a promotion by ID. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. */ promotion?: Maybe; /** * List of the promotions. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. */ promotions?: Maybe; + /** Refunds related settings. Returns `RefundSettings` configuration, global for the entire shop. */ + refundSettings: RefundSettings; /** * List of top selling products. * * Requires one of the following permissions: MANAGE_PRODUCTS. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ reportProductSales?: Maybe; /** * Look up a sale by ID. * * Requires one of the following permissions: MANAGE_DISCOUNTS. - * @deprecated This field will be removed in Saleor 4.0. Use the `promotion` query instead. + * @deprecated Use the `promotion` query instead. */ sale?: Maybe; /** * List of the shop's sales. * * Requires one of the following permissions: MANAGE_DISCOUNTS. - * @deprecated This field will be removed in Saleor 4.0. Use the `promotions` query instead. + * @deprecated Use the `promotions` query instead. */ sales?: Maybe; /** @@ -24697,32 +23866,24 @@ export type Query = { /** * Look up a tax class. * - * Added in Saleor 3.9. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */ taxClass?: Maybe; /** * List of tax classes. * - * Added in Saleor 3.9. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */ taxClasses?: Maybe; /** * Look up a tax configuration. * - * Added in Saleor 3.9. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */ taxConfiguration?: Maybe; /** * List of tax configurations. * - * Added in Saleor 3.9. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */ taxConfigurations?: Maybe; @@ -24736,19 +23897,23 @@ export type Query = { taxCountryConfigurations?: Maybe>; /** * List of all tax rates available from tax gateway. - * @deprecated This field will be removed in Saleor 4.0. Use `taxClasses` field instead. + * @deprecated Use `taxClasses` field instead. */ taxTypes?: Maybe>; /** * Look up a transaction by ID. * - * Added in Saleor 3.6. + * 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. * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Added in Saleor 3.22. * - * Requires one of the following permissions: HANDLE_PAYMENTS. + * Requires one of the following permissions: HANDLE_PAYMENTS, MANAGE_ORDERS. */ - transaction?: Maybe; + transactions?: Maybe; /** * Lookup a translatable item by ID. * @@ -24797,7 +23962,7 @@ export type Query = { * List of all available webhook events. * * Requires one of the following permissions: MANAGE_APPS. - * @deprecated This field will be removed in Saleor 4.0. Use `WebhookEventTypeAsyncEnum` and `WebhookEventTypeSyncEnum` to get available event types. + * @deprecated Use `WebhookEventTypeAsyncEnum` and `WebhookEventTypeSyncEnum` to get available event types. */ webhookEvents?: Maybe>; /** 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. */ @@ -24887,6 +24052,7 @@ export type QueryCategoriesArgs = { export type QueryCategoryArgs = { id?: InputMaybe; slug?: InputMaybe; + slugLanguageCode?: InputMaybe; }; @@ -24925,6 +24091,7 @@ export type QueryCollectionArgs = { channel?: InputMaybe; id?: InputMaybe; slug?: InputMaybe; + slugLanguageCode?: InputMaybe; }; @@ -24946,7 +24113,9 @@ export type QueryCustomersArgs = { filter?: InputMaybe; first?: InputMaybe; last?: InputMaybe; + search?: InputMaybe; sortBy?: InputMaybe; + where?: InputMaybe; }; @@ -24969,7 +24138,9 @@ export type QueryDraftOrdersArgs = { filter?: InputMaybe; first?: InputMaybe; last?: InputMaybe; + search?: InputMaybe; sortBy?: InputMaybe; + where?: InputMaybe; }; @@ -25075,7 +24246,9 @@ export type QueryOrdersArgs = { filter?: InputMaybe; first?: InputMaybe; last?: InputMaybe; + search?: InputMaybe; sortBy?: InputMaybe; + where?: InputMaybe; }; @@ -25086,8 +24259,10 @@ export type QueryOrdersTotalArgs = { export type QueryPageArgs = { + channel?: InputMaybe; id?: InputMaybe; slug?: InputMaybe; + slugLanguageCode?: InputMaybe; }; @@ -25109,10 +24284,13 @@ export type QueryPageTypesArgs = { export type QueryPagesArgs = { after?: InputMaybe; before?: InputMaybe; + channel?: InputMaybe; filter?: InputMaybe; first?: InputMaybe; last?: InputMaybe; + search?: InputMaybe; sortBy?: InputMaybe; + where?: InputMaybe; }; @@ -25165,6 +24343,7 @@ export type QueryProductArgs = { externalReference?: InputMaybe; id?: InputMaybe; slug?: InputMaybe; + slugLanguageCode?: InputMaybe; }; @@ -25199,6 +24378,7 @@ export type QueryProductVariantsArgs = { first?: InputMaybe; ids?: InputMaybe>; last?: InputMaybe; + search?: InputMaybe; sortBy?: InputMaybe; where?: InputMaybe; }; @@ -25340,6 +24520,15 @@ export type QueryTransactionArgs = { }; +export type QueryTransactionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + where?: InputMaybe; +}; + + export type QueryTranslationArgs = { id: Scalars['ID']['input']; kind: TranslatableKinds; @@ -25405,25 +24594,110 @@ export type QueryWebhookSamplePayloadArgs = { eventType: WebhookSampleEventTypeEnum; }; -/** Represents a reduced VAT rate for a particular type of goods. */ -export type ReducedRate = { - __typename?: 'ReducedRate'; - /** Reduced VAT rate in percent. */ - rate: Scalars['Float']['output']; - /** A type of goods. */ - rateType: Scalars['String']['output']; +/** Represents a reduced VAT rate for a particular type of goods. */ +export type ReducedRate = { + __typename?: 'ReducedRate'; + /** Reduced VAT rate in percent. */ + rate: Scalars['Float']['output']; + /** A type of goods. */ + rateType: Scalars['String']['output']; +}; + +/** + * 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. + */ +export type ReferenceType = PageType | ProductType; + +/** 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. */ +export type RefreshToken = { + __typename?: 'RefreshToken'; + /** @deprecated Use `errors` field instead. */ + accountErrors: Array; + errors: Array; + /** JWT token, required to authenticate. */ + token?: Maybe; + /** A user instance. */ + user?: Maybe; +}; + +/** + * 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. + * + * Added in Saleor 3.22. + * + * Requires one of the following permissions: MANAGE_SETTINGS. + */ +export type RefundReasonReferenceTypeClear = { + __typename?: 'RefundReasonReferenceTypeClear'; + errors: Array; + /** Refund settings. */ + refundSettings: RefundSettings; + /** @deprecated Use `errors` field instead. */ + refundSettingsErrors: Array; +}; + +export type RefundReasonReferenceTypeClearError = { + __typename?: 'RefundReasonReferenceTypeClearError'; + /** Failed to clear refund reason reference type */ + code: RefundSettingsErrorCode; + /** 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; +}; + +/** + * Refund related settings from site settings. + * + * Added in Saleor 3.22. + */ +export type RefundSettings = { + __typename?: 'RefundSettings'; + /** Model type used for refund reasons. */ + reasonReferenceType?: Maybe; +}; + +export enum RefundSettingsErrorCode { + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + Required = 'REQUIRED' +} + +/** + * Update refund settings across all channels. + * + * Added in Saleor 3.22. + * + * Requires one of the following permissions: MANAGE_SETTINGS. + */ +export type RefundSettingsUpdate = { + __typename?: 'RefundSettingsUpdate'; + errors: Array; + /** Refund settings. */ + refundSettings: RefundSettings; + /** @deprecated Use `errors` field instead. */ + refundSettingsErrors: Array; +}; + +export type RefundSettingsUpdateError = { + __typename?: 'RefundSettingsUpdateError'; + /** Failed to update Refund Settings */ + code: RefundSettingsErrorCode; + /** 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; }; -/** 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. */ -export type RefreshToken = { - __typename?: 'RefreshToken'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ - accountErrors: Array; - errors: Array; - /** JWT token, required to authenticate. */ - token?: Maybe; - /** A user instance. */ - user?: Maybe; +export type 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. + * + * Added in Saleor 3.22. + */ + refundReasonReferenceType: Scalars['ID']['input']; }; export type ReorderInput = { @@ -25449,7 +24723,7 @@ export enum ReportingPeriod { */ export type RequestEmailChange = { __typename?: 'RequestEmailChange'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** A user instance. */ @@ -25466,18 +24740,16 @@ export type RequestEmailChange = { */ export type RequestPasswordReset = { __typename?: 'RequestPasswordReset'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; }; -/** An enumeration. */ export enum RewardTypeEnum { Gift = 'GIFT', SubtotalDiscount = 'SUBTOTAL_DISCOUNT' } -/** An enumeration. */ export enum RewardValueTypeEnum { Fixed = 'FIXED', Percentage = 'PERCENTAGE' @@ -25486,7 +24758,7 @@ export enum RewardValueTypeEnum { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type Sale = Node & ObjectWithMetadata & { __typename?: 'Sale'; @@ -25520,15 +24792,9 @@ export type Sale = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** The name of the sale. */ name: Scalars['String']['output']; @@ -25538,15 +24804,9 @@ export type Sale = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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 products this sale applies to. @@ -25565,8 +24825,6 @@ export type Sale = Node & ObjectWithMetadata & { /** * List of product variants this sale applies to. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. */ variants?: Maybe; @@ -25576,7 +24834,7 @@ export type Sale = Node & ObjectWithMetadata & { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type SaleCategoriesArgs = { after?: InputMaybe; @@ -25589,7 +24847,7 @@ export type SaleCategoriesArgs = { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type SaleCollectionsArgs = { after?: InputMaybe; @@ -25602,7 +24860,7 @@ export type SaleCollectionsArgs = { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type SaleMetafieldArgs = { key: Scalars['String']['input']; @@ -25612,7 +24870,7 @@ export type SaleMetafieldArgs = { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type SaleMetafieldsArgs = { keys?: InputMaybe>; @@ -25622,7 +24880,7 @@ export type SaleMetafieldsArgs = { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type SalePrivateMetafieldArgs = { key: Scalars['String']['input']; @@ -25632,7 +24890,7 @@ export type SalePrivateMetafieldArgs = { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type SalePrivateMetafieldsArgs = { keys?: InputMaybe>; @@ -25642,7 +24900,7 @@ export type SalePrivateMetafieldsArgs = { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type SaleProductsArgs = { after?: InputMaybe; @@ -25655,7 +24913,7 @@ export type SaleProductsArgs = { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type SaleTranslationArgs = { languageCode: LanguageCodeEnum; @@ -25665,7 +24923,7 @@ export type SaleTranslationArgs = { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type SaleVariantsArgs = { after?: InputMaybe; @@ -25677,8 +24935,6 @@ export type SaleVariantsArgs = { /** * Adds products, categories, collections to a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionRuleCreate` mutation instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -25686,7 +24942,7 @@ export type SaleVariantsArgs = { */ export type SaleAddCatalogues = { __typename?: 'SaleAddCatalogues'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; /** Sale of which catalogue IDs will be modified. */ @@ -25705,7 +24961,7 @@ export type SaleBulkDelete = { __typename?: 'SaleBulkDelete'; /** Returns how many objects were affected. */ count: Scalars['Int']['output']; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; }; @@ -25713,7 +24969,7 @@ export type SaleBulkDelete = { /** * Represents sale channel listing. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `PromotionRule` type instead. + * DEPRECATED: this type will be removed. Use `PromotionRule` type instead. */ export type SaleChannelListing = Node & { __typename?: 'SaleChannelListing'; @@ -25744,13 +25000,11 @@ export type SaleChannelListingInput = { /** * Manage sale's availability in channels. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionRuleCreate` or `promotionRuleUpdate` mutations instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. */ export type SaleChannelListingUpdate = { __typename?: 'SaleChannelListingUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; /** An updated sale instance. */ @@ -25777,8 +25031,6 @@ export type SaleCountableEdge = { /** * Creates a new sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionCreate` mutation instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -25786,7 +25038,7 @@ export type SaleCountableEdge = { */ export type SaleCreate = { __typename?: 'SaleCreate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; sale?: Maybe; @@ -25795,9 +25047,7 @@ export type SaleCreate = { /** * Event sent when new sale is created. * - * Added in Saleor 3.2. - * - * DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionCreated` event instead. + * DEPRECATED: this event will be removed. Use `PromotionCreated` event instead. */ export type SaleCreated = Event & { __typename?: 'SaleCreated'; @@ -25817,9 +25067,7 @@ export type SaleCreated = Event & { /** * Event sent when new sale is created. * - * Added in Saleor 3.2. - * - * DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionCreated` event instead. + * DEPRECATED: this event will be removed. Use `PromotionCreated` event instead. */ export type SaleCreatedSaleArgs = { channel?: InputMaybe; @@ -25828,8 +25076,6 @@ export type SaleCreatedSaleArgs = { /** * Deletes a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionDelete` mutation instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -25837,7 +25083,7 @@ export type SaleCreatedSaleArgs = { */ export type SaleDelete = { __typename?: 'SaleDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; sale?: Maybe; @@ -25846,9 +25092,7 @@ export type SaleDelete = { /** * Event sent when sale is deleted. * - * Added in Saleor 3.2. - * - * DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionDeleted` event instead. + * DEPRECATED: this event will be removed. Use `PromotionDeleted` event instead. */ export type SaleDeleted = Event & { __typename?: 'SaleDeleted'; @@ -25868,9 +25112,7 @@ export type SaleDeleted = Event & { /** * Event sent when sale is deleted. * - * Added in Saleor 3.2. - * - * DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionDeleted` event instead. + * DEPRECATED: this event will be removed. Use `PromotionDeleted` event instead. */ export type SaleDeletedSaleArgs = { channel?: InputMaybe; @@ -25908,8 +25150,6 @@ export type SaleInput = { /** * Removes products, categories, collections from a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionRuleUpdate` or `promotionRuleDelete` mutations instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -25917,7 +25157,7 @@ export type SaleInput = { */ export type SaleRemoveCatalogues = { __typename?: 'SaleRemoveCatalogues'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; /** Sale of which catalogue IDs will be modified. */ @@ -25925,11 +25165,11 @@ export type SaleRemoveCatalogues = { }; export enum SaleSortField { - /** Sort sales by created at. */ + /** Sort sales by creation date. */ CreatedAt = 'CREATED_AT', /** Sort sales by end date. */ EndDate = 'END_DATE', - /** Sort sales by last modified at. */ + /** Sort sales by last modification date. */ LastModifiedAt = 'LAST_MODIFIED_AT', /** Sort sales by name. */ Name = 'NAME', @@ -25948,8 +25188,7 @@ export enum SaleSortField { export type SaleSortingInput = { /** * Specifies the channel in which to sort the data. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. + * @deprecated Use root-level channel argument instead. */ channel?: InputMaybe; /** Specifies the direction in which to sort sales. */ @@ -25961,9 +25200,7 @@ export type SaleSortingInput = { /** * The event informs about the start or end of the sale. * - * Added in Saleor 3.5. - * - * DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionStarted` and `PromotionEnded` events instead. + * DEPRECATED: this event will be removed. Use `PromotionStarted` and `PromotionEnded` events instead. */ export type SaleToggle = Event & { __typename?: 'SaleToggle'; @@ -25973,11 +25210,7 @@ export type SaleToggle = Event & { issuingPrincipal?: Maybe; /** The application receiving the webhook. */ recipient?: Maybe; - /** - * The sale the event relates to. - * - * Added in Saleor 3.5. - */ + /** The sale the event relates to. */ sale?: Maybe; /** Saleor version that triggered the event. */ version?: Maybe; @@ -25987,9 +25220,7 @@ export type SaleToggle = Event & { /** * The event informs about the start or end of the sale. * - * Added in Saleor 3.5. - * - * DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionStarted` and `PromotionEnded` events instead. + * DEPRECATED: this event will be removed. Use `PromotionStarted` and `PromotionEnded` events instead. */ export type SaleToggleSaleArgs = { channel?: InputMaybe; @@ -25998,7 +25229,7 @@ export type SaleToggleSaleArgs = { /** * Represents sale's original translatable fields and related translations. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `PromotionTranslatableContent` instead. + * DEPRECATED: this type will be removed. Use `PromotionTranslatableContent` instead. */ export type SaleTranslatableContent = Node & { __typename?: 'SaleTranslatableContent'; @@ -26010,14 +25241,10 @@ export type SaleTranslatableContent = Node & { * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * * Requires one of the following permissions: MANAGE_DISCOUNTS. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ sale?: Maybe; - /** - * The ID of the sale to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the sale to translate. */ saleId: Scalars['ID']['output']; /** Returns translated sale fields for the given language code. */ translation?: Maybe; @@ -26027,7 +25254,7 @@ export type SaleTranslatableContent = Node & { /** * Represents sale's original translatable fields and related translations. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `PromotionTranslatableContent` instead. + * DEPRECATED: this type will be removed. Use `PromotionTranslatableContent` instead. */ export type SaleTranslatableContentTranslationArgs = { languageCode: LanguageCodeEnum; @@ -26036,22 +25263,20 @@ export type SaleTranslatableContentTranslationArgs = { /** * Creates/updates translations for a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `PromotionTranslate` mutation instead. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. */ export type SaleTranslate = { __typename?: 'SaleTranslate'; errors: Array; sale?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; /** * Represents sale translations. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `PromotionTranslation` instead. + * DEPRECATED: this type will be removed. Use `PromotionTranslation` instead. */ export type SaleTranslation = Node & { __typename?: 'SaleTranslation'; @@ -26061,11 +25286,7 @@ export type SaleTranslation = Node & { language: LanguageDisplay; /** Translated name of sale. */ name?: Maybe; - /** - * Represents the sale fields to translate. - * - * Added in Saleor 3.14. - */ + /** Represents the sale fields to translate. */ translatableContent?: Maybe; }; @@ -26077,8 +25298,6 @@ export enum SaleType { /** * Updates a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionUpdate` mutation instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -26087,7 +25306,7 @@ export enum SaleType { */ export type SaleUpdate = { __typename?: 'SaleUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; sale?: Maybe; @@ -26096,9 +25315,7 @@ export type SaleUpdate = { /** * Event sent when sale is updated. * - * Added in Saleor 3.2. - * - * DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionUpdated` event instead. + * DEPRECATED: this event will be removed. Use `PromotionUpdated` event instead. */ export type SaleUpdated = Event & { __typename?: 'SaleUpdated'; @@ -26118,15 +25335,13 @@ export type SaleUpdated = Event & { /** * Event sent when sale is updated. * - * Added in Saleor 3.2. - * - * DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionUpdated` event instead. + * DEPRECATED: this event will be removed. Use `PromotionUpdated` event instead. */ export type SaleUpdatedSaleArgs = { channel?: InputMaybe; }; -/** Represents a custom attribute. */ +/** Represents an assigned attribute to an object. */ export type SelectedAttribute = { __typename?: 'SelectedAttribute'; /** Name of an attribute displayed in the interface. */ @@ -26138,10 +25353,6 @@ export type SelectedAttribute = { /** * Sends a notification confirmation. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_USER. * * Triggers the following webhook events: @@ -26163,7 +25374,6 @@ export type SendConfirmationEmailError = { message?: Maybe; }; -/** An enumeration. */ export enum SendConfirmationEmailErrorCode { AccountConfirmed = 'ACCOUNT_CONFIRMED', ConfirmationAlreadyRequested = 'CONFIRMATION_ALREADY_REQUESTED', @@ -26181,7 +25391,7 @@ export type SeoInput = { /** Sets the user's password from the token sent by email using the RequestPasswordReset mutation. */ export type SetPassword = { __typename?: 'SetPassword'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; /** CSRF token required to re-generate access token. */ csrfToken?: Maybe; @@ -26208,7 +25418,6 @@ export type ShippingError = { warehouses?: Maybe>; }; -/** An enumeration. */ export enum ShippingErrorCode { AlreadyExists = 'ALREADY_EXISTS', DuplicatedInputItem = 'DUPLICATED_INPUT_ITEM', @@ -26220,11 +25429,7 @@ export enum ShippingErrorCode { Unique = 'UNIQUE' } -/** - * List shipping methods for checkout. - * - * Added in Saleor 3.6. - */ +/** List shipping methods for checkout. */ export type ShippingListMethodsForCheckout = Event & { __typename?: 'ShippingListMethodsForCheckout'; /** The checkout the event relates to. */ @@ -26235,11 +25440,7 @@ export type ShippingListMethodsForCheckout = Event & { issuingPrincipal?: Maybe; /** The application receiving the webhook. */ recipient?: Maybe; - /** - * Shipping methods that can be used with this checkout. - * - * Added in Saleor 3.6. - */ + /** Shipping methods that can be used with this checkout. */ shippingMethods?: Maybe>; /** Saleor version that triggered the event. */ version?: Maybe; @@ -26264,7 +25465,7 @@ export type ShippingMethod = Node & ObjectWithMetadata & { maximumOrderPrice?: Maybe; /** * Maximum order weight for this shipping method. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ maximumOrderWeight?: Maybe; /** Message connected to this shipping method. */ @@ -26285,7 +25486,7 @@ export type ShippingMethod = Node & ObjectWithMetadata & { minimumOrderPrice?: Maybe; /** * Minimum order weight for this shipping method. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ minimumOrderWeight?: Maybe; /** Shipping method name. */ @@ -26306,7 +25507,7 @@ export type ShippingMethod = Node & ObjectWithMetadata & { translation?: Maybe; /** * Type of the shipping method. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ type?: Maybe; }; @@ -26382,7 +25583,7 @@ export type ShippingMethodChannelListingInput = { export type ShippingMethodChannelListingUpdate = { __typename?: 'ShippingMethodChannelListingUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; /** An updated shipping method instance. */ shippingMethod?: Maybe; @@ -26418,14 +25619,10 @@ export type ShippingMethodTranslatableContent = Node & { * Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers. * * Requires one of the following permissions: MANAGE_SHIPPING. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ shippingMethod?: Maybe; - /** - * The ID of the shipping method to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the shipping method to translate. */ shippingMethodId: Scalars['ID']['output']; /** Returns translated shipping method fields for the given language code. */ translation?: Maybe; @@ -26452,11 +25649,7 @@ export type ShippingMethodTranslation = Node & { language: LanguageDisplay; /** Translated shipping method name. */ name?: Maybe; - /** - * Represents the shipping method fields to translate. - * - * Added in Saleor 3.14. - */ + /** Represents the shipping method fields to translate. */ translatableContent?: Maybe; }; @@ -26495,15 +25688,9 @@ export type ShippingMethodType = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Minimal number of days for delivery. */ minimumDeliveryDays?: Maybe; @@ -26521,15 +25708,9 @@ export type ShippingMethodType = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** * Tax class assigned to this shipping method. @@ -26582,17 +25763,12 @@ export type ShippingMethodTypeTranslationArgs = { languageCode: LanguageCodeEnum; }; -/** An enumeration. */ export enum ShippingMethodTypeEnum { Price = 'PRICE', Weight = 'WEIGHT' } -/** - * List of shipping methods available for the country. - * - * Added in Saleor 3.6. - */ +/** List of shipping methods available for the country. */ export type ShippingMethodsPerCountry = { __typename?: 'ShippingMethodsPerCountry'; /** The country code. */ @@ -26618,7 +25794,7 @@ export type ShippingPriceBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; }; @@ -26630,18 +25806,14 @@ export type ShippingPriceBulkDelete = { export type ShippingPriceCreate = { __typename?: 'ShippingPriceCreate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; shippingMethod?: Maybe; /** A shipping zone to which the shipping method belongs. */ shippingZone?: Maybe; }; -/** - * Event sent when new shipping price is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new shipping price is created. */ export type ShippingPriceCreated = Event & { __typename?: 'ShippingPriceCreated'; /** Time of the event. */ @@ -26659,21 +25831,13 @@ export type ShippingPriceCreated = Event & { }; -/** - * Event sent when new shipping price is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new shipping price is created. */ export type ShippingPriceCreatedShippingMethodArgs = { channel?: InputMaybe; }; -/** - * Event sent when new shipping price is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new shipping price is created. */ export type ShippingPriceCreatedShippingZoneArgs = { channel?: InputMaybe; }; @@ -26686,7 +25850,7 @@ export type ShippingPriceCreatedShippingZoneArgs = { export type ShippingPriceDelete = { __typename?: 'ShippingPriceDelete'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; /** A shipping method to delete. */ shippingMethod?: Maybe; @@ -26694,11 +25858,7 @@ export type ShippingPriceDelete = { shippingZone?: Maybe; }; -/** - * Event sent when shipping price is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping price is deleted. */ export type ShippingPriceDeleted = Event & { __typename?: 'ShippingPriceDeleted'; /** Time of the event. */ @@ -26716,21 +25876,13 @@ export type ShippingPriceDeleted = Event & { }; -/** - * Event sent when shipping price is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping price is deleted. */ export type ShippingPriceDeletedShippingMethodArgs = { channel?: InputMaybe; }; -/** - * Event sent when shipping price is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping price is deleted. */ export type ShippingPriceDeletedShippingZoneArgs = { channel?: InputMaybe; }; @@ -26743,7 +25895,7 @@ export type ShippingPriceDeletedShippingZoneArgs = { export type ShippingPriceExcludeProducts = { __typename?: 'ShippingPriceExcludeProducts'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; /** A shipping method with new list of excluded products. */ shippingMethod?: Maybe; @@ -26789,7 +25941,7 @@ export type ShippingPriceInput = { export type ShippingPriceRemoveProductFromExclude = { __typename?: 'ShippingPriceRemoveProductFromExclude'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; /** A shipping method with new list of excluded products. */ shippingMethod?: Maybe; @@ -26804,7 +25956,7 @@ export type ShippingPriceTranslate = { __typename?: 'ShippingPriceTranslate'; errors: Array; shippingMethod?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; @@ -26826,18 +25978,14 @@ export type ShippingPriceTranslationInput = { export type ShippingPriceUpdate = { __typename?: 'ShippingPriceUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; shippingMethod?: Maybe; /** A shipping zone to which the shipping method belongs. */ shippingZone?: Maybe; }; -/** - * Event sent when shipping price is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping price is updated. */ export type ShippingPriceUpdated = Event & { __typename?: 'ShippingPriceUpdated'; /** Time of the event. */ @@ -26855,21 +26003,13 @@ export type ShippingPriceUpdated = Event & { }; -/** - * Event sent when shipping price is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping price is updated. */ export type ShippingPriceUpdatedShippingMethodArgs = { channel?: InputMaybe; }; -/** - * Event sent when shipping price is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping price is updated. */ export type ShippingPriceUpdatedShippingZoneArgs = { channel?: InputMaybe; }; @@ -26893,15 +26033,9 @@ export type ShippingZone = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Shipping zone name. */ name: Scalars['String']['output']; @@ -26913,15 +26047,9 @@ export type ShippingZone = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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 shipping methods available for orders shipped to countries within this shipping zone. */ shippingMethods?: Maybe>; @@ -26963,7 +26091,7 @@ export type ShippingZoneBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; }; @@ -26992,7 +26120,7 @@ export type ShippingZoneCountableEdge = { export type ShippingZoneCreate = { __typename?: 'ShippingZoneCreate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; shippingZone?: Maybe; }; @@ -27012,11 +26140,7 @@ export type ShippingZoneCreateInput = { name?: InputMaybe; }; -/** - * Event sent when new shipping zone is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new shipping zone is created. */ export type ShippingZoneCreated = Event & { __typename?: 'ShippingZoneCreated'; /** Time of the event. */ @@ -27032,11 +26156,7 @@ export type ShippingZoneCreated = Event & { }; -/** - * Event sent when new shipping zone is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new shipping zone is created. */ export type ShippingZoneCreatedShippingZoneArgs = { channel?: InputMaybe; }; @@ -27049,16 +26169,12 @@ export type ShippingZoneCreatedShippingZoneArgs = { export type ShippingZoneDelete = { __typename?: 'ShippingZoneDelete'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; shippingZone?: Maybe; }; -/** - * Event sent when shipping zone is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping zone is deleted. */ export type ShippingZoneDeleted = Event & { __typename?: 'ShippingZoneDeleted'; /** Time of the event. */ @@ -27074,11 +26190,7 @@ export type ShippingZoneDeleted = Event & { }; -/** - * Event sent when shipping zone is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping zone is deleted. */ export type ShippingZoneDeletedShippingZoneArgs = { channel?: InputMaybe; }; @@ -27088,11 +26200,7 @@ export type ShippingZoneFilterInput = { search?: InputMaybe; }; -/** - * Event sent when shipping zone metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when shipping zone metadata is updated. */ export type ShippingZoneMetadataUpdated = Event & { __typename?: 'ShippingZoneMetadataUpdated'; /** Time of the event. */ @@ -27108,11 +26216,7 @@ export type ShippingZoneMetadataUpdated = Event & { }; -/** - * Event sent when shipping zone metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when shipping zone metadata is updated. */ export type ShippingZoneMetadataUpdatedShippingZoneArgs = { channel?: InputMaybe; }; @@ -27125,7 +26229,7 @@ export type ShippingZoneMetadataUpdatedShippingZoneArgs = { export type ShippingZoneUpdate = { __typename?: 'ShippingZoneUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; shippingZone?: Maybe; }; @@ -27149,11 +26253,7 @@ export type ShippingZoneUpdateInput = { removeWarehouses?: InputMaybe>; }; -/** - * Event sent when shipping zone is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping zone is updated. */ export type ShippingZoneUpdated = Event & { __typename?: 'ShippingZoneUpdated'; /** Time of the event. */ @@ -27169,11 +26269,7 @@ export type ShippingZoneUpdated = Event & { }; -/** - * Event sent when shipping zone is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping zone is updated. */ export type ShippingZoneUpdatedShippingZoneArgs = { channel?: InputMaybe; }; @@ -27184,8 +26280,6 @@ export type Shop = ObjectWithMetadata & { /** * Determines if user can login without confirmation when `enableAccountConfirmation` is enabled. * - * Added in Saleor 3.15. - * * Requires one of the following permissions: MANAGE_SETTINGS. */ allowLoginWithoutConfirmation?: Maybe; @@ -27212,14 +26306,12 @@ export type Shop = ObjectWithMetadata & { /** * List of all currencies supported by shop's channels. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */ channelCurrencies: Array; /** * Charge taxes on shipping. - * @deprecated This field will be removed in Saleor 4.0. Use `ShippingMethodType.taxClass` to determine whether taxes are calculated for shipping methods; if a tax class is set, the taxes will be calculated, otherwise no tax rate will be applied. + * @deprecated 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. */ chargeTaxesOnShipping: Scalars['Boolean']['output']; /** Company address. */ @@ -27260,7 +26352,7 @@ export type Shop = ObjectWithMetadata & { description?: Maybe; /** * Display prices with tax in store. - * @deprecated This field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to determine whether to display gross or net prices. + * @deprecated Use `Channel.taxConfiguration` to determine whether to display gross or net prices. */ displayGrossPrices: Scalars['Boolean']['output']; /** Shop's domain data. */ @@ -27268,22 +26360,12 @@ export type Shop = ObjectWithMetadata & { /** * Determines if account confirmation by email is enabled. * - * Added in Saleor 3.14. - * * Requires one of the following permissions: MANAGE_SETTINGS. */ enableAccountConfirmationByEmail?: Maybe; - /** - * Allow to approve fulfillments which are unpaid. - * - * Added in Saleor 3.1. - */ + /** Allow to approve fulfillments which are unpaid. */ fulfillmentAllowUnpaid: Scalars['Boolean']['output']; - /** - * Automatically approve all new fulfillments. - * - * Added in Saleor 3.1. - */ + /** Automatically approve all new fulfillments. */ fulfillmentAutoApprove: Scalars['Boolean']['output']; /** Header text. */ headerText?: Maybe; @@ -27291,7 +26373,7 @@ export type Shop = ObjectWithMetadata & { id: Scalars['ID']['output']; /** * Include taxes in prices. - * @deprecated This field will be removed in Saleor 4.0. Use `Channel.taxConfiguration.pricesEnteredWithTax` to determine whether prices are entered with tax. + * @deprecated Use `Channel.taxConfiguration.pricesEnteredWithTax` to determine whether prices are entered with tax. */ includeTaxesInPrices: Scalars['Boolean']['output']; /** List of the shops's supported languages. */ @@ -27299,8 +26381,6 @@ export type Shop = ObjectWithMetadata & { /** * Default number of maximum line quantity in single checkout (per single checkout line). * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_SETTINGS. */ limitQuantityPerCheckout?: Maybe; @@ -27308,7 +26388,7 @@ export type Shop = ObjectWithMetadata & { * Resource limitations and current usage if any set for a shop * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ limits: LimitInfo; /** List of public metadata items. Can be accessed without permissions. */ @@ -27340,24 +26420,16 @@ export type Shop = ObjectWithMetadata & { /** * Default number of minutes stock will be reserved for anonymous checkout or null when stock reservation is disabled. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_SETTINGS. */ reserveStockDurationAnonymousUser?: Maybe; /** * Default number of minutes stock will be reserved for authenticated checkout or null when stock reservation is disabled. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_SETTINGS. */ reserveStockDurationAuthenticatedUser?: Maybe; - /** - * Minor Saleor API version. - * - * Added in Saleor 3.5. - */ + /** Minor Saleor API version. */ schemaVersion: Scalars['String']['output']; /** * List of staff notification recipients. @@ -27369,6 +26441,13 @@ export type Shop = ObjectWithMetadata & { trackInventoryByDefault?: Maybe; /** Returns translated shop fields for the given language code. */ translation?: Maybe; + /** + * 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 Field no longer supported + */ + useLegacyUpdateWebhookEmission?: Maybe; /** * Saleor API version. * @@ -27438,15 +26517,13 @@ export type ShopAddressUpdate = { errors: Array; /** Updated shop. */ shop?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shopErrors: Array; }; /** * Updates site domain of the shop. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `PUBLIC_URL` environment variable instead. - * * Requires one of the following permissions: MANAGE_SETTINGS. */ export type ShopDomainUpdate = { @@ -27454,7 +26531,7 @@ export type ShopDomainUpdate = { errors: Array; /** Updated shop. */ shop?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shopErrors: Array; }; @@ -27468,7 +26545,6 @@ export type ShopError = { message?: Maybe; }; -/** An enumeration. */ export enum ShopErrorCode { AlreadyExists = 'ALREADY_EXISTS', CannotFetchTaxRates = 'CANNOT_FETCH_TAX_RATES', @@ -27489,15 +26565,11 @@ export type ShopFetchTaxRates = { errors: Array; /** Updated shop. */ shop?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shopErrors: Array; }; -/** - * Event sent when shop metadata is updated. - * - * Added in Saleor 3.15. - */ +/** Event sent when shop metadata is updated. */ export type ShopMetadataUpdated = Event & { __typename?: 'ShopMetadataUpdated'; /** Time of the event. */ @@ -27513,18 +26585,13 @@ export type ShopMetadataUpdated = Event & { }; export type ShopSettingsInput = { - /** - * Enable possibility to login without account confirmation. - * - * Added in Saleor 3.15. - */ + /** Enable possibility to login without account confirmation. */ allowLoginWithoutConfirmation?: InputMaybe; /** Enable automatic fulfillment for all digital products. */ automaticFulfillmentDigitalProducts?: InputMaybe; /** * Charge taxes on shipping. - * - * DEPRECATED: this field will be removed in Saleor 4.0. To enable taxes for a shipping method, assign a tax class to the shipping method with `shippingPriceCreate` or `shippingPriceUpdate` mutations. + * @deprecated To enable taxes for a shipping method, assign a tax class to the shipping method with `shippingPriceCreate` or `shippingPriceUpdate` mutations. */ chargeTaxesOnShipping?: InputMaybe; /** URL of a view where customers can set their password. */ @@ -27543,68 +26610,49 @@ export type ShopSettingsInput = { description?: InputMaybe; /** * Display prices with tax in store. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `taxConfigurationUpdate` mutation to configure this setting per channel or country. + * @deprecated Use `taxConfigurationUpdate` mutation to configure this setting per channel or country. */ displayGrossPrices?: InputMaybe; - /** - * Enable automatic account confirmation by email. - * - * Added in Saleor 3.14. - */ + /** Enable automatic account confirmation by email. */ enableAccountConfirmationByEmail?: InputMaybe; - /** - * Enable ability to approve fulfillments which are unpaid. - * - * Added in Saleor 3.1. - */ + /** Enable ability to approve fulfillments which are unpaid. */ fulfillmentAllowUnpaid?: InputMaybe; - /** - * Enable automatic approval of all new fulfillments. - * - * Added in Saleor 3.1. - */ + /** Enable automatic approval of all new fulfillments. */ fulfillmentAutoApprove?: InputMaybe; /** Header text. */ headerText?: InputMaybe; /** * Include taxes in prices. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `taxConfigurationUpdate` mutation to configure this setting per channel or country. + * @deprecated Use `taxConfigurationUpdate` mutation to configure this setting per channel or country. */ includeTaxesInPrices?: InputMaybe; - /** - * Default number of maximum line quantity in single checkout. Minimum possible value is 1, default value is 50. - * - * Added in Saleor 3.1. - */ + /** Default number of maximum line quantity in single checkout. Minimum possible value is 1, default value is 50. */ limitQuantityPerCheckout?: InputMaybe; /** - * Shop public metadata. + * Shop public metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.15. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** - * Shop private metadata. + * Shop private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.15. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; - /** - * Default number of minutes stock will be reserved for anonymous checkout. Enter 0 or null to disable. - * - * Added in Saleor 3.1. - */ + /** Default number of minutes stock will be reserved for anonymous checkout. Enter 0 or null to disable. */ reserveStockDurationAnonymousUser?: InputMaybe; - /** - * Default number of minutes stock will be reserved for authenticated checkout. Enter 0 or null to disable. - * - * Added in Saleor 3.1. - */ + /** Default number of minutes stock will be reserved for authenticated checkout. Enter 0 or null to disable. */ reserveStockDurationAuthenticatedUser?: InputMaybe; /** This field is used as a default value for `ProductVariant.trackInventory`. */ trackInventoryByDefault?: InputMaybe; + /** + * 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 Field no longer supported + */ + useLegacyUpdateWebhookEmission?: InputMaybe; }; /** @@ -27617,7 +26665,7 @@ export type ShopSettingsTranslate = { errors: Array; /** Updated shop settings. */ shop?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; @@ -27639,7 +26687,7 @@ export type ShopSettingsUpdate = { errors: Array; /** Updated shop. */ shop?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shopErrors: Array; }; @@ -27676,7 +26724,7 @@ export type StaffBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ staffErrors: Array; }; @@ -27693,7 +26741,7 @@ export type StaffBulkDelete = { export type StaffCreate = { __typename?: 'StaffCreate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ staffErrors: Array; user?: Maybe; }; @@ -27711,28 +26759,24 @@ export type StaffCreateInput = { /** Family name. */ lastName?: InputMaybe; /** - * Fields required to update the user metadata. + * Fields required to update the user metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** A note about the user. */ note?: InputMaybe; /** - * Fields required to update the user private metadata. + * Fields required to update the user private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** URL of a view where users should be redirected to set the password. URL in RFC 1808 format. */ redirectUrl?: InputMaybe; }; -/** - * Event sent when new staff user is created. - * - * Added in Saleor 3.5. - */ +/** Event sent when new staff user is created. */ export type StaffCreated = Event & { __typename?: 'StaffCreated'; /** Time of the event. */ @@ -27758,16 +26802,12 @@ export type StaffCreated = Event & { export type StaffDelete = { __typename?: 'StaffDelete'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ staffErrors: Array; user?: Maybe; }; -/** - * Event sent when staff user is deleted. - * - * Added in Saleor 3.5. - */ +/** Event sent when staff user is deleted. */ export type StaffDeleted = Event & { __typename?: 'StaffDeleted'; /** Time of the event. */ @@ -27829,20 +26869,20 @@ export type StaffNotificationRecipient = Node & { export type StaffNotificationRecipientCreate = { __typename?: 'StaffNotificationRecipientCreate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shopErrors: Array; staffNotificationRecipient?: Maybe; }; /** - * Delete staff notification recipient. + * Deletes staff notification recipient. * * Requires one of the following permissions: MANAGE_SETTINGS. */ export type StaffNotificationRecipientDelete = { __typename?: 'StaffNotificationRecipientDelete'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shopErrors: Array; staffNotificationRecipient?: Maybe; }; @@ -27864,16 +26904,12 @@ export type StaffNotificationRecipientInput = { export type StaffNotificationRecipientUpdate = { __typename?: 'StaffNotificationRecipientUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shopErrors: Array; staffNotificationRecipient?: Maybe; }; -/** - * Event sent when setting a new password for staff is requested. - * - * Added in Saleor 3.15. - */ +/** Event sent when setting a new password for staff is requested. */ export type StaffSetPasswordRequested = Event & { __typename?: 'StaffSetPasswordRequested'; /** The channel data. */ @@ -27907,7 +26943,7 @@ export type StaffSetPasswordRequested = Event & { export type StaffUpdate = { __typename?: 'StaffUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ staffErrors: Array; user?: Maybe; }; @@ -27925,28 +26961,24 @@ export type StaffUpdateInput = { /** Family name. */ lastName?: InputMaybe; /** - * Fields required to update the user metadata. + * Fields required to update the user metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** A note about the user. */ note?: InputMaybe; /** - * Fields required to update the user private metadata. + * Fields required to update the user private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** List of permission group IDs from which user should be unassigned. */ removeGroups?: InputMaybe>; }; -/** - * Event sent when staff user is updated. - * - * Added in Saleor 3.5. - */ +/** Event sent when staff user is updated. */ export type StaffUpdated = Event & { __typename?: 'StaffUpdated'; /** Time of the event. */ @@ -28012,10 +27044,6 @@ export type StockBulkResult = { /** * 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. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_PRODUCTS. * * Triggers the following webhook events: @@ -28040,7 +27068,6 @@ export type StockBulkUpdateError = { message?: Maybe; }; -/** An enumeration. */ export enum StockBulkUpdateErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', @@ -28088,7 +27115,6 @@ export type StockError = { message?: Maybe; }; -/** An enumeration. */ export enum StockErrorCode { AlreadyExists = 'ALREADY_EXISTS', GraphqlError = 'GRAPHQL_ERROR', @@ -28110,11 +27136,7 @@ export type StockInput = { warehouse: Scalars['ID']['input']; }; -/** - * Represents the channel stock settings. - * - * Added in Saleor 3.7. - */ +/** Represents the channel stock settings. */ export type StockSettings = { __typename?: 'StockSettings'; /** Allocation strategy defines the preference of warehouses for allocations and reservations. */ @@ -28156,13 +27178,7 @@ export enum StorePaymentMethodEnum { OnSession = 'ON_SESSION' } -/** - * Represents a payment method stored for user (tokenized) in payment gateway. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents a payment method stored for user (tokenized) in payment gateway. */ export type StoredPaymentMethod = { __typename?: 'StoredPaymentMethod'; /** Stored credit card details if available. */ @@ -28182,13 +27198,7 @@ export type StoredPaymentMethod = { type: Scalars['String']['output']; }; -/** - * Event sent when user requests to delete a payment method. - * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when user requests to delete a payment method. */ export type StoredPaymentMethodDeleteRequested = Event & { __typename?: 'StoredPaymentMethodDeleteRequested'; /** Channel related to the requested delete action. */ @@ -28210,10 +27220,6 @@ export type StoredPaymentMethodDeleteRequested = Event & { /** * Request to delete a stored payment method on payment provider side. * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_USER. * * Triggers the following webhook events: @@ -28226,7 +27232,6 @@ export type StoredPaymentMethodRequestDelete = { result: StoredPaymentMethodRequestDeleteResult; }; -/** An enumeration. */ export enum StoredPaymentMethodRequestDeleteErrorCode { ChannelInactive = 'CHANNEL_INACTIVE', GatewayError = 'GATEWAY_ERROR', @@ -28250,13 +27255,7 @@ export enum StoredPaymentMethodRequestDeleteResult { SuccessfullyDeleted = 'SUCCESSFULLY_DELETED' } -/** - * Define the filtering options for string fields. - * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Define the filtering options for string fields. */ export type StringFilterInput = { /** The value equal to. */ eq?: InputMaybe; @@ -28266,6 +27265,48 @@ export type StringFilterInput = { export type Subscription = { __typename?: 'Subscription'; + /** Synchronous webhook for calculating checkout/order taxes. */ + calculateTaxes?: Maybe; + /** + * Event sent when new checkout is created. + * + * Added in Saleor 3.21. + * + * Note: this API is currently in Feature Preview and can be subject to changes at later point. + */ + checkoutCreated?: Maybe; + /** + * Event sent when checkout is fully authorized. + * + * Added in Saleor 3.21. + * + * Note: this API is currently in Feature Preview and can be subject to changes at later point. + */ + checkoutFullyAuthorized?: Maybe; + /** + * Event sent when checkout is fully-paid. + * + * Added in Saleor 3.21. + * + * Note: this API is currently in Feature Preview and can be subject to changes at later point. + */ + checkoutFullyPaid?: Maybe; + /** + * Event sent when checkout metadata is updated. + * + * Added in Saleor 3.21. + * + * Note: this API is currently in Feature Preview and can be subject to changes at later point. + */ + checkoutMetadataUpdated?: Maybe; + /** + * Event sent when checkout is updated. + * + * Added in Saleor 3.21. + * + * Note: this API is currently in Feature Preview and can be subject to changes at later point. + */ + checkoutUpdated?: Maybe; /** * Event sent when new draft order is created. * @@ -28290,11 +27331,7 @@ export type Subscription = { * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ draftOrderUpdated?: Maybe; - /** - * Look up subscription event. - * - * Added in Saleor 3.2. - */ + /** Look up subscription event. */ event?: Maybe; /** * Event sent when orders are imported. @@ -28395,6 +27432,36 @@ export type Subscription = { }; +export type SubscriptionCalculateTaxesArgs = { + deferIf?: InputMaybe>; +}; + + +export type SubscriptionCheckoutCreatedArgs = { + channels?: InputMaybe>; +}; + + +export type SubscriptionCheckoutFullyAuthorizedArgs = { + channels?: InputMaybe>; +}; + + +export type SubscriptionCheckoutFullyPaidArgs = { + channels?: InputMaybe>; +}; + + +export type SubscriptionCheckoutMetadataUpdatedArgs = { + channels?: InputMaybe>; +}; + + +export type SubscriptionCheckoutUpdatedArgs = { + channels?: InputMaybe>; +}; + + export type SubscriptionDraftOrderCreatedArgs = { channels?: InputMaybe>; }; @@ -28474,11 +27541,7 @@ export enum TaxCalculationStrategy { TaxApp = 'TAX_APP' } -/** - * Tax class is a named object used to define tax rates per country. Tax class can be assigned to product types, products and shipping methods to define their tax rates. - * - * Added in Saleor 3.9. - */ +/** 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. */ export type TaxClass = Node & ObjectWithMetadata & { __typename?: 'TaxClass'; /** Country-specific tax rates for this tax class. */ @@ -28491,15 +27554,9 @@ export type TaxClass = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Name of the tax class. */ name: Scalars['String']['output']; @@ -28509,54 +27566,32 @@ export type TaxClass = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; }; -/** - * Tax class is a named object used to define tax rates per country. Tax class can be assigned to product types, products and shipping methods to define their tax rates. - * - * Added in Saleor 3.9. - */ +/** 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. */ export type TaxClassMetafieldArgs = { key: Scalars['String']['input']; }; -/** - * Tax class is a named object used to define tax rates per country. Tax class can be assigned to product types, products and shipping methods to define their tax rates. - * - * Added in Saleor 3.9. - */ +/** 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. */ export type TaxClassMetafieldsArgs = { keys?: InputMaybe>; }; -/** - * Tax class is a named object used to define tax rates per country. Tax class can be assigned to product types, products and shipping methods to define their tax rates. - * - * Added in Saleor 3.9. - */ +/** 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. */ export type TaxClassPrivateMetafieldArgs = { key: Scalars['String']['input']; }; -/** - * Tax class is a named object used to define tax rates per country. Tax class can be assigned to product types, products and shipping methods to define their tax rates. - * - * Added in Saleor 3.9. - */ +/** 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. */ export type TaxClassPrivateMetafieldsArgs = { keys?: InputMaybe>; }; @@ -28578,11 +27613,7 @@ export type TaxClassCountableEdge = { node: TaxClass; }; -/** - * Tax rate for a country. When tax class is null, it represents the default tax rate for that country; otherwise it's a country tax rate specific to the given tax class. - * - * Added in Saleor 3.9. - */ +/** 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. */ export type TaxClassCountryRate = { __typename?: 'TaxClassCountryRate'; /** Country in which this tax rate applies. */ @@ -28594,9 +27625,7 @@ export type TaxClassCountryRate = { }; /** - * Create a tax class. - * - * Added in Saleor 3.9. + * Creates a tax class. * * Requires one of the following permissions: MANAGE_TAXES. */ @@ -28618,7 +27647,6 @@ export type TaxClassCreateError = { message?: Maybe; }; -/** An enumeration. */ export enum TaxClassCreateErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', @@ -28633,9 +27661,7 @@ export type TaxClassCreateInput = { }; /** - * Delete a tax class. After deleting the tax class any products, product types or shipping methods using it are updated to use the default tax class. - * - * Added in Saleor 3.9. + * 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. * * Requires one of the following permissions: MANAGE_TAXES. */ @@ -28655,7 +27681,6 @@ export type TaxClassDeleteError = { message?: Maybe; }; -/** An enumeration. */ export enum TaxClassDeleteErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', @@ -28688,9 +27713,7 @@ export type TaxClassSortingInput = { }; /** - * Update a tax class. - * - * Added in Saleor 3.9. + * Updates a tax class. * * Requires one of the following permissions: MANAGE_TAXES. */ @@ -28712,7 +27735,6 @@ export type TaxClassUpdateError = { message?: Maybe; }; -/** An enumeration. */ export enum TaxClassUpdateErrorCode { DuplicatedInputItem = 'DUPLICATED_INPUT_ITEM', GraphqlError = 'GRAPHQL_ERROR', @@ -28729,11 +27751,7 @@ export type TaxClassUpdateInput = { updateCountryRates?: InputMaybe>; }; -/** - * Channel-specific tax configuration. - * - * Added in Saleor 3.9. - */ +/** Channel-specific tax configuration. */ export type TaxConfiguration = Node & ObjectWithMetadata & { __typename?: 'TaxConfiguration'; /** A channel to which the tax configuration applies to. */ @@ -28752,15 +27770,9 @@ export type TaxConfiguration = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Determines whether prices are entered with the tax included. */ pricesEnteredWithTax: Scalars['Boolean']['output']; @@ -28770,15 +27782,9 @@ export type TaxConfiguration = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** * 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`. @@ -28788,44 +27794,34 @@ export type TaxConfiguration = Node & ObjectWithMetadata & { taxAppId?: Maybe; /** 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?: Maybe; + /** + * 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?: Maybe; }; -/** - * Channel-specific tax configuration. - * - * Added in Saleor 3.9. - */ +/** Channel-specific tax configuration. */ export type TaxConfigurationMetafieldArgs = { key: Scalars['String']['input']; }; -/** - * Channel-specific tax configuration. - * - * Added in Saleor 3.9. - */ +/** Channel-specific tax configuration. */ export type TaxConfigurationMetafieldsArgs = { keys?: InputMaybe>; }; -/** - * Channel-specific tax configuration. - * - * Added in Saleor 3.9. - */ +/** Channel-specific tax configuration. */ export type TaxConfigurationPrivateMetafieldArgs = { key: Scalars['String']['input']; }; -/** - * Channel-specific tax configuration. - * - * Added in Saleor 3.9. - */ +/** Channel-specific tax configuration. */ export type TaxConfigurationPrivateMetafieldsArgs = { keys?: InputMaybe>; }; @@ -28852,11 +27848,7 @@ export type TaxConfigurationFilterInput = { metadata?: InputMaybe>; }; -/** - * Country-specific exceptions of a channel's tax configuration. - * - * Added in Saleor 3.9. - */ +/** Country-specific exceptions of a channel's tax configuration. */ export type TaxConfigurationPerCountry = { __typename?: 'TaxConfigurationPerCountry'; /** Determines whether taxes are charged in this country. */ @@ -28873,6 +27865,12 @@ export type TaxConfigurationPerCountry = { taxAppId?: Maybe; /** 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?: Maybe; + /** + * 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?: Maybe; }; export type TaxConfigurationPerCountryInput = { @@ -28890,12 +27888,16 @@ export type TaxConfigurationPerCountryInput = { taxAppId?: InputMaybe; /** 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?: InputMaybe; + /** + * 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. Default value is `False`.Can be used only with `taxCalculationStrategy` set to `FLAT_RATES`. + * + * Added in Saleor 3.21. + */ + useWeightedTaxForShipping?: InputMaybe; }; /** - * Update tax configuration for a channel. - * - * Added in Saleor 3.9. + * Updates tax configuration for a channel. * * Requires one of the following permissions: MANAGE_TAXES. */ @@ -28917,7 +27919,6 @@ export type TaxConfigurationUpdateError = { message?: Maybe; }; -/** An enumeration. */ export enum TaxConfigurationUpdateErrorCode { DuplicatedInputItem = 'DUPLICATED_INPUT_ITEM', GraphqlError = 'GRAPHQL_ERROR', @@ -28944,13 +27945,15 @@ export type TaxConfigurationUpdateInput = { taxCalculationStrategy?: InputMaybe; /** List of tax country configurations to create or update (identified by a country code). */ updateCountriesConfiguration?: InputMaybe>; + /** + * 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. Default value is `False`.Can be used only with `taxCalculationStrategy` set to `FLAT_RATES`. + * + * Added in Saleor 3.21. + */ + useWeightedTaxForShipping?: InputMaybe; }; -/** - * Tax class rates grouped by country. - * - * Added in Saleor 3.9. - */ +/** Tax class rates grouped by country. */ export type TaxCountryConfiguration = { __typename?: 'TaxCountryConfiguration'; /** A country for which tax class rates are grouped. */ @@ -28962,8 +27965,6 @@ export type TaxCountryConfiguration = { /** * Remove all tax class rates for a specific country. * - * Added in Saleor 3.9. - * * Requires one of the following permissions: MANAGE_TAXES. */ export type TaxCountryConfigurationDelete = { @@ -28983,7 +27984,6 @@ export type TaxCountryConfigurationDeleteError = { message?: Maybe; }; -/** An enumeration. */ export enum TaxCountryConfigurationDeleteErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', @@ -28991,9 +27991,7 @@ export enum TaxCountryConfigurationDeleteErrorCode { } /** - * Update tax class rates for a specific country. - * - * Added in Saleor 3.9. + * Updates tax class rates for a specific country. * * Requires one of the following permissions: MANAGE_TAXES. */ @@ -29016,7 +28014,6 @@ export type TaxCountryConfigurationUpdateError = { taxClassIds: Array; }; -/** An enumeration. */ export enum TaxCountryConfigurationUpdateErrorCode { CannotCreateNegativeRate = 'CANNOT_CREATE_NEGATIVE_RATE', GraphqlError = 'GRAPHQL_ERROR', @@ -29028,8 +28025,6 @@ export enum TaxCountryConfigurationUpdateErrorCode { /** * Exempt checkout or order from charging the taxes. When tax exemption is enabled, taxes won't be charged for the checkout or order. Taxes may still be calculated in cases when product prices are entered with the tax included and the net price needs to be known. * - * Added in Saleor 3.8. - * * Requires one of the following permissions: MANAGE_TAXES. */ export type TaxExemptionManage = { @@ -29048,7 +28043,6 @@ export type TaxExemptionManageError = { message?: Maybe; }; -/** An enumeration. */ export enum TaxExemptionManageErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', @@ -29155,48 +28149,27 @@ export type TaxedMoneyRange = { stop?: Maybe; }; -/** - * Event sent when thumbnail is created. - * - * Added in Saleor 3.12. - */ +/** Event sent when thumbnail is created. */ export type ThumbnailCreated = Event & { __typename?: 'ThumbnailCreated'; - /** - * Thumbnail id. - * - * Added in Saleor 3.12. - */ + /** Thumbnail id. */ id?: Maybe; /** Time of the event. */ issuedAt?: Maybe; /** The user or application that triggered the event. */ issuingPrincipal?: Maybe; - /** - * Original media url. - * - * Added in Saleor 3.12. - */ + /** Original media url. */ mediaUrl?: Maybe; - /** - * Object the thumbnail refers to. - * - * Added in Saleor 3.12. - */ + /** Object the thumbnail refers to. */ objectId?: Maybe; /** The application receiving the webhook. */ recipient?: Maybe; - /** - * Thumbnail url. - * - * Added in Saleor 3.12. - */ + /** Thumbnail url. */ url?: Maybe; /** Saleor version that triggered the event. */ version?: Maybe; }; -/** An enumeration. */ export enum ThumbnailFormatEnum { Avif = 'AVIF', Original = 'ORIGINAL', @@ -29218,7 +28191,6 @@ export type TimePeriodInputType = { type: TimePeriodTypeEnum; }; -/** An enumeration. */ export enum TimePeriodTypeEnum { Day = 'DAY', Month = 'MONTH', @@ -29246,7 +28218,10 @@ export type Transaction = Node & { created: Scalars['DateTime']['output']; /** Error associated with transaction, if any. */ error?: Maybe; - /** Response returned by payment gateway. */ + /** + * Response returned by payment gateway. + * @deprecated This field is a part of a legacy Payments API. Please use apps instead. + */ gatewayResponse: Scalars['JSONString']['output']; /** ID of the transaction. */ id: Scalars['ID']['output']; @@ -29264,13 +28239,9 @@ export type TransactionAction = { __typename?: 'TransactionAction'; /** Determines the action type. */ actionType: TransactionActionEnum; - /** Transaction request amount. Null when action type is VOID. */ - amount?: Maybe; - /** - * Currency code. - * - * Added in Saleor 3.16. - */ + /** Transaction request amount. */ + amount: Scalars['PositiveDecimal']['output']; + /** Currency code. */ currency: Scalars['String']['output']; }; @@ -29288,13 +28259,7 @@ export enum TransactionActionEnum { Refund = 'REFUND' } -/** - * Event sent when transaction cancelation is requested. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when transaction cancelation is requested. */ export type TransactionCancelationRequested = Event & { __typename?: 'TransactionCancelationRequested'; /** Requested action data. */ @@ -29311,13 +28276,7 @@ export type TransactionCancelationRequested = Event & { version?: Maybe; }; -/** - * Event sent when transaction charge is requested. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when transaction charge is requested. */ export type TransactionChargeRequested = Event & { __typename?: 'TransactionChargeRequested'; /** Requested action data. */ @@ -29334,12 +28293,25 @@ export type TransactionChargeRequested = Event & { version?: Maybe; }; +export type TransactionCountableConnection = { + __typename?: 'TransactionCountableConnection'; + edges: Array; + /** Pagination data for this connection. */ + pageInfo: PageInfo; + /** A total count of items in the collection. */ + totalCount?: Maybe; +}; + +export type TransactionCountableEdge = { + __typename?: 'TransactionCountableEdge'; + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of the edge. */ + node: TransactionItem; +}; + /** - * Create transaction for checkout or order. - * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Creates transaction for checkout or order. * * Requires one of the following permissions: HANDLE_PAYMENTS. */ @@ -29359,7 +28331,6 @@ export type TransactionCreateError = { message?: Maybe; }; -/** An enumeration. */ export enum TransactionCreateErrorCode { GraphqlError = 'GRAPHQL_ERROR', IncorrectCurrency = 'INCORRECT_CURRENCY', @@ -29372,11 +28343,7 @@ export enum TransactionCreateErrorCode { export type TransactionCreateInput = { /** Amount authorized by this transaction. */ amountAuthorized?: InputMaybe; - /** - * Amount canceled by this transaction. - * - * Added in Saleor 3.13. - */ + /** Amount canceled by this transaction. */ amountCanceled?: InputMaybe; /** Amount charged by this transaction. */ amountCharged?: InputMaybe; @@ -29384,110 +28351,79 @@ export type TransactionCreateInput = { amountRefunded?: InputMaybe; /** List of all possible actions for the transaction */ availableActions?: InputMaybe>; - /** - * The url that will allow to redirect user to payment provider page with transaction event details. - * - * Added in Saleor 3.13. - */ + /** The url that will allow to redirect user to payment provider page with transaction event details. */ externalUrl?: InputMaybe; + /** The message of the transaction. */ + message?: InputMaybe; /** - * The message of the transaction. + * Payment public metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.13. + * Warning: never store sensitive information, including financial data such as credit card details. */ - message?: InputMaybe; - /** Payment public metadata. */ metadata?: InputMaybe>; + /** Payment name of the transaction. */ + name?: InputMaybe; /** - * Payment name of the transaction. + * Details of the payment method used for the transaction. * - * Added in Saleor 3.13. + * Added in Saleor 3.22. */ - name?: InputMaybe; - /** Payment private metadata. */ - privateMetadata?: InputMaybe>; + paymentMethodDetails?: InputMaybe; /** - * PSP Reference of the transaction. + * Payment private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.13. + * Warning: never store sensitive information, including financial data such as credit card details. */ + privateMetadata?: InputMaybe>; + /** PSP Reference of the transaction. */ pspReference?: InputMaybe; }; /** Represents transaction's event. */ export type TransactionEvent = Node & { __typename?: 'TransactionEvent'; - /** - * The amount related to this event. - * - * Added in Saleor 3.13. - */ + /** The amount related to this event. */ amount: Money; /** Date and time at which a transaction event was created. */ createdAt: Scalars['DateTime']['output']; - /** - * User or App that created the transaction event. - * - * Added in Saleor 3.13. - */ + /** User or App that created the transaction event. */ createdBy?: Maybe; - /** - * The url that will allow to redirect user to payment provider page with transaction details. - * - * Added in Saleor 3.13. - */ + /** The url that will allow to redirect user to payment provider page with transaction details. */ externalUrl: Scalars['String']['output']; /** The ID of the object. */ id: Scalars['ID']['output']; - /** - * Idempotency key assigned to the event. - * - * Added in Saleor 3.14. - */ + /** Idempotency key assigned to the event. */ idempotencyKey?: Maybe; - /** - * Message related to the transaction's event. - * - * Added in Saleor 3.13. - */ + /** Message related to the transaction's event. */ message: Scalars['String']['output']; - /** - * PSP reference of transaction. - * - * Added in Saleor 3.13. - */ + /** PSP reference of transaction. */ pspReference: Scalars['String']['output']; /** - * The type of action related to this event. + * Reason model of the transaction refund. * - * Added in Saleor 3.13. + * Added in Saleor 3.22. */ + reasonReference?: Maybe; + /** The type of action related to this event. */ type?: Maybe; }; export type TransactionEventInput = { - /** - * The message related to the event. - * - * Added in Saleor 3.13. - */ + /** The message related to the event. */ message?: InputMaybe; - /** - * PSP Reference related to this action. - * - * Added in Saleor 3.13. - */ + /** PSP Reference related to this action. */ pspReference?: InputMaybe; }; /** * Report the event for the transaction. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app. + * + * Triggers the following webhook events: + * - TRANSACTION_ITEM_METADATA_UPDATED (async): Optionally called when transaction's metadata was updated. + * - 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. */ export type TransactionEventReport = { __typename?: 'TransactionEventReport'; @@ -29510,13 +28446,13 @@ export type TransactionEventReportError = { message?: Maybe; }; -/** An enumeration. */ export enum TransactionEventReportErrorCode { AlreadyExists = 'ALREADY_EXISTS', GraphqlError = 'GRAPHQL_ERROR', IncorrectDetails = 'INCORRECT_DETAILS', Invalid = 'INVALID', - NotFound = 'NOT_FOUND' + NotFound = 'NOT_FOUND', + Required = 'REQUIRED' } /** @@ -29567,6 +28503,20 @@ export enum TransactionEventTypeEnum { RefundSuccess = 'REFUND_SUCCESS' } +/** Filter input for transactions. */ +export type TransactionFilterInput = { + /** Filter by metadata fields of transactions. */ + metadata?: InputMaybe; + /** Filter by payment method details used to pay for the order. */ + paymentMethodDetails?: InputMaybe; + /** + * Filter by PSP reference of transactions. + * + * Added in Saleor 3.22. + */ + pspReference?: InputMaybe; +}; + /** * Determine the transaction flow strategy. * @@ -29578,13 +28528,7 @@ export enum TransactionFlowStrategyEnum { Charge = 'CHARGE' } -/** - * 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. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** 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. */ export type TransactionInitialize = { __typename?: 'TransactionInitialize'; /** The JSON data required to finalize the payment. */ @@ -29606,7 +28550,6 @@ export type TransactionInitializeError = { message?: Maybe; }; -/** An enumeration. */ export enum TransactionInitializeErrorCode { CheckoutCompletionInProgress = 'CHECKOUT_COMPLETION_IN_PROGRESS', GraphqlError = 'GRAPHQL_ERROR', @@ -29615,30 +28558,16 @@ export enum TransactionInitializeErrorCode { Unique = 'UNIQUE' } -/** - * Event sent when user starts processing the payment. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when user starts processing the payment. */ export type TransactionInitializeSession = Event & { __typename?: 'TransactionInitializeSession'; /** Action to proceed for the transaction */ action: TransactionProcessAction; - /** - * The customer's IP address. If not provided as a parameter in the mutation, Saleor will try to determine the customer's IP address on its own. - * - * Added in Saleor 3.16. - */ + /** The customer's IP address. If not provided as a parameter in the mutation, Saleor will try to determine the customer's IP address on its own. */ customerIpAddress?: Maybe; /** Payment gateway data in JSON format, received from storefront. */ data?: Maybe; - /** - * Idempotency key assigned to the transaction initialize. - * - * Added in Saleor 3.14. - */ + /** Idempotency key assigned to the transaction initialize. */ idempotencyKey: Scalars['String']['output']; /** Time of the event. */ issuedAt?: Maybe; @@ -29656,196 +28585,116 @@ export type TransactionInitializeSession = Event & { version?: Maybe; }; -/** - * Represents a payment transaction. - * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents a payment transaction. */ export type TransactionItem = Node & ObjectWithMetadata & { __typename?: 'TransactionItem'; /** List of actions that can be performed in the current state of a payment. */ actions: Array; - /** - * Total amount of ongoing authorization requests for the transaction. - * - * Added in Saleor 3.13. - */ + /** Total amount of ongoing authorization requests for the transaction. */ authorizePendingAmount: Money; /** Total amount authorized for this payment. */ authorizedAmount: Money; - /** - * Total amount of ongoing cancel requests for the transaction. - * - * Added in Saleor 3.13. - */ + /** Total amount of ongoing cancel requests for the transaction. */ cancelPendingAmount: Money; - /** - * Total amount canceled for this payment. - * - * Added in Saleor 3.13. - */ + /** Total amount canceled for this payment. */ canceledAmount: Money; - /** - * Total amount of ongoing charge requests for the transaction. - * - * Added in Saleor 3.13. - */ + /** Total amount of ongoing charge requests for the transaction. */ chargePendingAmount: Money; /** Total amount charged for this payment. */ chargedAmount: Money; - /** - * The related checkout. - * - * Added in Saleor 3.14. - */ + /** The related checkout. */ checkout?: Maybe; /** Date and time at which payment transaction was created. */ createdAt: Scalars['DateTime']['output']; - /** - * User or App that created the transaction. - * - * Added in Saleor 3.13. - */ + /** User or App that created the transaction. */ createdBy?: Maybe; /** List of all transaction's events. */ events: Array; - /** - * The url that will allow to redirect user to payment provider page with transaction details. - * - * Added in Saleor 3.13. - */ + /** The url that will allow to redirect user to payment provider page with transaction details. */ externalUrl: Scalars['String']['output']; /** The ID of the object. */ id: Scalars['ID']['output']; - /** - * Message related to the transaction. - * - * Added in Saleor 3.13. - */ + /** Message related to the transaction. */ message: Scalars['String']['output']; /** List of public metadata items. Can be accessed without permissions. */ metadata: Array; /** - * A single key from public metadata. - * - * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. - */ - metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. + * A single key from public metadata. * - * Added in Saleor 3.3. + * Tip: Use GraphQL aliases to fetch multiple keys. */ + metafield?: Maybe; + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Date and time at which payment transaction was modified. */ modifiedAt: Scalars['DateTime']['output']; - /** - * Name of the transaction. - * - * Added in Saleor 3.13. - */ + /** Name of the transaction. */ name: Scalars['String']['output']; + /** The related order. */ + order?: Maybe; /** - * The related order. + * The payment method used for this transaction. * - * Added in Saleor 3.6. + * Added in Saleor 3.22. */ - order?: Maybe; + paymentMethodDetails?: Maybe; /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; /** * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; + /** PSP reference of transaction. */ + pspReference: Scalars['String']['output']; /** - * PSP reference of transaction. + * Reason of the refund. * - * Added in Saleor 3.13. + * Added in Saleor 3.22. */ - pspReference: Scalars['String']['output']; + reason?: Maybe; /** - * Total amount of ongoing refund requests for the transaction. + * Reason `Page` (Model) for refund. * - * Added in Saleor 3.13. + * Added in Saleor 3.22. */ + reasonReference?: Maybe; + /** Total amount of ongoing refund requests for the transaction. */ refundPendingAmount: Money; /** Total amount refunded for this payment. */ refundedAmount: Money; - /** - * The transaction token. - * - * Added in Saleor 3.14. - */ + /** The transaction token. */ token: Scalars['UUID']['output']; }; -/** - * Represents a payment transaction. - * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents a payment transaction. */ export type TransactionItemMetafieldArgs = { key: Scalars['String']['input']; }; -/** - * Represents a payment transaction. - * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents a payment transaction. */ export type TransactionItemMetafieldsArgs = { keys?: InputMaybe>; }; -/** - * Represents a payment transaction. - * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents a payment transaction. */ export type TransactionItemPrivateMetafieldArgs = { key: Scalars['String']['input']; }; -/** - * Represents a payment transaction. - * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents a payment transaction. */ export type TransactionItemPrivateMetafieldsArgs = { keys?: InputMaybe>; }; -/** - * Event sent when transaction item metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when transaction item metadata is updated. */ export type TransactionItemMetadataUpdated = Event & { __typename?: 'TransactionItemMetadataUpdated'; /** Time of the event. */ @@ -29860,7 +28709,6 @@ export type TransactionItemMetadataUpdated = Event & { version?: Maybe; }; -/** An enumeration. */ export enum TransactionKind { ActionToConfirm = 'ACTION_TO_CONFIRM', Auth = 'AUTH', @@ -29874,13 +28722,7 @@ export enum TransactionKind { Void = 'VOID' } -/** - * Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. */ export type TransactionProcess = { __typename?: 'TransactionProcess'; /** The json data required to finalize the payment. */ @@ -29911,7 +28753,6 @@ export type TransactionProcessError = { message?: Maybe; }; -/** An enumeration. */ export enum TransactionProcessErrorCode { CheckoutCompletionInProgress = 'CHECKOUT_COMPLETION_IN_PROGRESS', GraphqlError = 'GRAPHQL_ERROR', @@ -29922,22 +28763,12 @@ export enum TransactionProcessErrorCode { TransactionAlreadyProcessed = 'TRANSACTION_ALREADY_PROCESSED' } -/** - * Event sent when user has additional payment action to process. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when user has additional payment action to process. */ export type TransactionProcessSession = Event & { __typename?: 'TransactionProcessSession'; /** Action to proceed for the transaction */ action: TransactionProcessAction; - /** - * The customer's IP address. If not provided as a parameter in the mutation, Saleor will try to determine the customer's IP address on its own. - * - * Added in Saleor 3.16. - */ + /** The customer's IP address. If not provided as a parameter in the mutation, Saleor will try to determine the customer's IP address on its own. */ customerIpAddress?: Maybe; /** Payment gateway data in JSON format, received from storefront. */ data?: Maybe; @@ -29957,13 +28788,7 @@ export type TransactionProcessSession = Event & { version?: Maybe; }; -/** - * Event sent when transaction refund is requested. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when transaction refund is requested. */ export type TransactionRefundRequested = Event & { __typename?: 'TransactionRefundRequested'; /** Requested action data. */ @@ -29971,8 +28796,6 @@ export type TransactionRefundRequested = Event & { /** * Granted refund related to refund request. * - * Added in Saleor 3.15. - * * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ grantedRefund?: Maybe; @@ -29991,10 +28814,6 @@ export type TransactionRefundRequested = Event & { /** * Request an action for payment transaction. * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: HANDLE_PAYMENTS. */ export type TransactionRequestAction = { @@ -30013,21 +28832,17 @@ export type TransactionRequestActionError = { message?: Maybe; }; -/** An enumeration. */ export enum TransactionRequestActionErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', MissingTransactionActionRequestWebhook = 'MISSING_TRANSACTION_ACTION_REQUEST_WEBHOOK', - NotFound = 'NOT_FOUND' + NotFound = 'NOT_FOUND', + Required = 'REQUIRED' } /** * Request a refund for payment transaction based on granted refund. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: HANDLE_PAYMENTS. */ export type TransactionRequestRefundForGrantedRefund = { @@ -30046,7 +28861,6 @@ export type TransactionRequestRefundForGrantedRefundError = { message?: Maybe; }; -/** An enumeration. */ export enum TransactionRequestRefundForGrantedRefundErrorCode { AmountGreaterThanAvailable = 'AMOUNT_GREATER_THAN_AVAILABLE', GraphqlError = 'GRAPHQL_ERROR', @@ -30060,10 +28874,6 @@ export enum TransactionRequestRefundForGrantedRefundErrorCode { /** * Update transaction. * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app. */ export type TransactionUpdate = { @@ -30082,7 +28892,6 @@ export type TransactionUpdateError = { message?: Maybe; }; -/** An enumeration. */ export enum TransactionUpdateErrorCode { GraphqlError = 'GRAPHQL_ERROR', IncorrectCurrency = 'INCORRECT_CURRENCY', @@ -30095,11 +28904,7 @@ export enum TransactionUpdateErrorCode { export type TransactionUpdateInput = { /** Amount authorized by this transaction. */ amountAuthorized?: InputMaybe; - /** - * Amount canceled by this transaction. - * - * Added in Saleor 3.13. - */ + /** Amount canceled by this transaction. */ amountCanceled?: InputMaybe; /** Amount charged by this transaction. */ amountCharged?: InputMaybe; @@ -30107,36 +28912,46 @@ export type TransactionUpdateInput = { amountRefunded?: InputMaybe; /** List of all possible actions for the transaction */ availableActions?: InputMaybe>; - /** - * The url that will allow to redirect user to payment provider page with transaction event details. - * - * Added in Saleor 3.13. - */ + /** The url that will allow to redirect user to payment provider page with transaction event details. */ externalUrl?: InputMaybe; + /** The message of the transaction. */ + message?: InputMaybe; /** - * The message of the transaction. + * Payment public metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.13. + * Warning: never store sensitive information, including financial data such as credit card details. */ - message?: InputMaybe; - /** Payment public metadata. */ metadata?: InputMaybe>; + /** Payment name of the transaction. */ + name?: InputMaybe; /** - * Payment name of the transaction. + * Details of the payment method used for the transaction. * - * Added in Saleor 3.13. + * Added in Saleor 3.22. */ - name?: InputMaybe; - /** Payment private metadata. */ - privateMetadata?: InputMaybe>; + paymentMethodDetails?: InputMaybe; /** - * PSP Reference of the transaction. + * Payment private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.13. + * Warning: never store sensitive information, including financial data such as credit card details. */ + privateMetadata?: InputMaybe>; + /** PSP Reference of the transaction. */ pspReference?: InputMaybe; }; +export type TransactionWhereInput = { + /** List of conditions that must be met. */ + AND?: InputMaybe>; + /** A list of conditions of which at least one must be met. */ + OR?: InputMaybe>; + /** Filter by app identifier. */ + appIdentifier?: InputMaybe; + ids?: InputMaybe>; + /** Filter by PSP reference. */ + pspReference?: InputMaybe; +}; + export type TranslatableItem = AttributeTranslatableContent | AttributeValueTranslatableContent | CategoryTranslatableContent | CollectionTranslatableContent | MenuItemTranslatableContent | PageTranslatableContent | ProductTranslatableContent | ProductVariantTranslatableContent | PromotionRuleTranslatableContent | PromotionTranslatableContent | SaleTranslatableContent | ShippingMethodTranslatableContent | VoucherTranslatableContent; export type TranslatableItemConnection = { @@ -30172,11 +28987,7 @@ export enum TranslatableKinds { Voucher = 'VOUCHER' } -/** - * Event sent when new translation is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new translation is created. */ export type TranslationCreated = Event & { __typename?: 'TranslationCreated'; /** Time of the event. */ @@ -30201,12 +29012,12 @@ export type TranslationError = { message?: Maybe; }; -/** An enumeration. */ export enum TranslationErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', NotFound = 'NOT_FOUND', - Required = 'REQUIRED' + Required = 'REQUIRED', + Unique = 'UNIQUE' } export type TranslationInput = { @@ -30219,15 +29030,12 @@ export type TranslationInput = { name?: InputMaybe; seoDescription?: InputMaybe; seoTitle?: InputMaybe; + slug?: InputMaybe; }; export type TranslationTypes = AttributeTranslation | AttributeValueTranslation | CategoryTranslation | CollectionTranslation | MenuItemTranslation | PageTranslation | ProductTranslation | ProductVariantTranslation | PromotionRuleTranslation | PromotionTranslation | SaleTranslation | ShippingMethodTranslation | VoucherTranslation; -/** - * Event sent when translation is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when translation is updated. */ export type TranslationUpdated = Event & { __typename?: 'TranslationUpdated'; /** Time of the event. */ @@ -30242,40 +29050,56 @@ export type TranslationUpdated = Event & { version?: Maybe; }; +/** Define the filtering options for string fields. */ +export type UuidFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value included in. */ + oneOf?: InputMaybe>; +}; + export type UpdateInvoiceInput = { /** - * Fields required to update the invoice metadata. + * Fields required to update the invoice metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Invoice number */ number?: InputMaybe; /** - * Fields required to update the invoice private metadata. + * Fields required to update the invoice private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** URL of an invoice to download. */ url?: InputMaybe; }; -/** Updates metadata of an object. To use it, you need to have access to the modified object. */ +/** + * Updates metadata of an object.Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ export type UpdateMetadata = { __typename?: 'UpdateMetadata'; errors: Array; item?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ metadataErrors: Array; }; -/** Updates private metadata of an object. To use it, you need to be an authenticated staff user or an app and have access to the modified object. */ +/** + * Updates private metadata of an object. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ export type UpdatePrivateMetadata = { __typename?: 'UpdatePrivateMetadata'; errors: Array; item?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ metadataErrors: Array; }; @@ -30289,21 +29113,16 @@ export type UploadError = { message?: Maybe; }; -/** An enumeration. */ export enum UploadErrorCode { - GraphqlError = 'GRAPHQL_ERROR' + GraphqlError = 'GRAPHQL_ERROR', + InvalidFileType = 'INVALID_FILE_TYPE', + UnsupportedMimeType = 'UNSUPPORTED_MIME_TYPE' } /** Represents user data. */ export type User = Node & ObjectWithMetadata & { __typename?: 'User'; - /** - * List of channels the user has access to. The sum of channels from all user groups. If at least one group has `restrictedAccessToChannels` set to False - all channels are returned. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** 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?: Maybe>; /** List of all user's addresses. */ addresses: Array
; @@ -30311,21 +29130,17 @@ export type User = Node & ObjectWithMetadata & { avatar?: Maybe; /** * Returns the last open checkout of this user. - * @deprecated This field will be removed in Saleor 4.0. Use the `checkoutTokens` field to fetch the user checkouts. + * @deprecated Use the `checkoutTokens` field to fetch the user checkouts. */ checkout?: Maybe; /** Returns the checkout ID's assigned to this user. */ checkoutIds?: Maybe>; /** * Returns the checkout UUID's assigned to this user. - * @deprecated This field will be removed in Saleor 4.0. Use `checkoutIds` instead. + * @deprecated Use `checkoutIds` instead. */ checkoutTokens?: Maybe>; - /** - * Returns checkouts assigned to this user. - * - * Added in Saleor 3.8. - */ + /** 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?: Maybe; /** The data when the user create account. */ dateJoined: Scalars['DateTime']['output']; @@ -30343,11 +29158,7 @@ export type User = Node & ObjectWithMetadata & { * Requires one of the following permissions: MANAGE_USERS, MANAGE_STAFF. */ events?: Maybe>; - /** - * External ID of this user. - * - * Added in Saleor 3.10. - */ + /** External ID of this user. */ externalReference?: Maybe; /** The given name of the address. */ firstName: Scalars['String']['output']; @@ -30357,11 +29168,7 @@ export type User = Node & ObjectWithMetadata & { id: Scalars['ID']['output']; /** Determine if the user is active. */ isActive: Scalars['Boolean']['output']; - /** - * Determines if user has confirmed email. - * - * Added in Saleor 3.15. - */ + /** Determines if user has confirmed email. */ isConfirmed: Scalars['Boolean']['output']; /** Determine if the user is a staff admin. */ isStaff: Scalars['Boolean']['output']; @@ -30377,15 +29184,9 @@ export type User = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** * A note about the customer. @@ -30393,7 +29194,7 @@ export type User = Node & ObjectWithMetadata & { * Requires one of the following permissions: MANAGE_USERS, MANAGE_STAFF. */ note?: Maybe; - /** List of user's orders. Requires one of the following permissions: MANAGE_STAFF, OWNER. */ + /** 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?: Maybe; /** List of user's permission groups. */ permissionGroups?: Maybe>; @@ -30403,31 +29204,13 @@ export type User = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; - /** - * Determine if user have restricted access to channels. False if at least one user group has `restrictedAccessToChannels` set to False. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Determine if user have restricted access to channels. False if at least one user group has `restrictedAccessToChannels` set to False. */ restrictedAccessToChannels: Scalars['Boolean']['output']; - /** - * 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. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** 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?: Maybe>; /** List of stored payment sources. The field returns a list of payment sources stored for payment plugins. */ storedPaymentSources?: Maybe>; @@ -30527,7 +29310,7 @@ export type UserStoredPaymentSourcesArgs = { */ export type UserAvatarDelete = { __typename?: 'UserAvatarDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** An updated user instance. */ @@ -30541,7 +29324,7 @@ export type UserAvatarDelete = { */ export type UserAvatarUpdate = { __typename?: 'UserAvatarUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** An updated user instance. */ @@ -30555,7 +29338,7 @@ export type UserAvatarUpdate = { */ export type UserBulkSetActive = { __typename?: 'UserBulkSetActive'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; /** Returns how many objects were affected. */ count: Scalars['Int']['output']; @@ -30588,11 +29371,7 @@ export type UserCreateInput = { defaultShippingAddress?: InputMaybe; /** The unique email address of the user. */ email?: InputMaybe; - /** - * External ID of the customer. - * - * Added in Saleor 3.10. - */ + /** External ID of the customer. */ externalReference?: InputMaybe; /** Given name. */ firstName?: InputMaybe; @@ -30600,12 +29379,7 @@ export type UserCreateInput = { isActive?: InputMaybe; /** * User account is confirmed. - * - * Added in Saleor 3.15. - * - * DEPRECATED: this field will be removed in Saleor 4.0. - * - * The user will be always set as unconfirmed. The confirmation will take place when the user sets the password. + * @deprecated The user will be always set as unconfirmed. The confirmation will take place when the user sets the password. */ isConfirmed?: InputMaybe; /** User language code. */ @@ -30613,17 +29387,17 @@ export type UserCreateInput = { /** Family name. */ lastName?: InputMaybe; /** - * Fields required to update the user metadata. + * Fields required to update the user metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** A note about the user. */ note?: InputMaybe; /** - * Fields required to update the user private metadata. + * Fields required to update the user private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** URL of a view where users should be redirected to set the password. URL in RFC 1808 format. */ @@ -30697,7 +29471,7 @@ export type VariantMediaAssign = { __typename?: 'VariantMediaAssign'; errors: Array; media?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; productVariant?: Maybe; }; @@ -30711,7 +29485,7 @@ export type VariantMediaUnassign = { __typename?: 'VariantMediaUnassign'; errors: Array; media?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; productVariant?: Maybe; }; @@ -30723,18 +29497,30 @@ export type VariantPricingInfo = { discount?: Maybe; /** * The discount amount in the local currency. - * @deprecated This field will be removed in Saleor 4.0. Always returns `null`. + * @deprecated Always returns `null`. */ discountLocalCurrency?: Maybe; + /** + * 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?: Maybe; /** Whether it is in sale or not. */ onSale?: Maybe; /** The price, with any discount subtracted. */ price?: Maybe; /** * The discounted price in the local currency. - * @deprecated This field will be removed in Saleor 4.0. Always returns `null`. + * @deprecated Always returns `null`. */ priceLocalCurrency?: Maybe; + /** + * The price prior to discount. + * + * Added in Saleor 3.21. + */ + pricePrior?: Maybe; /** The price without any discount. */ priceUndiscounted?: Maybe; }; @@ -30742,7 +29528,7 @@ export type VariantPricingInfo = { /** Verify JWT token. */ export type VerifyToken = { __typename?: 'VerifyToken'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** Determine if token is valid or not. */ @@ -30753,7 +29539,6 @@ export type VerifyToken = { user?: Maybe; }; -/** An enumeration. */ export enum VolumeUnitsEnum { AcreFt = 'ACRE_FT', AcreIn = 'ACRE_IN', @@ -30785,7 +29570,7 @@ export type Voucher = Node & ObjectWithMetadata & { * Requires one of the following permissions: MANAGE_DISCOUNTS. */ channelListings?: Maybe>; - /** The code of the voucher.This field will be removed in Saleor 4.0. */ + /** The code of the voucher. */ code?: Maybe; /** * List of codes available for this voucher. @@ -30817,15 +29602,9 @@ export type Voucher = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Determine minimum quantity of items for checkout. */ minCheckoutItemsQuantity?: Maybe; @@ -30841,15 +29620,9 @@ export type Voucher = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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 products this voucher applies to. @@ -30878,8 +29651,6 @@ export type Voucher = Node & ObjectWithMetadata & { /** * List of product variants this voucher applies to. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. */ variants?: Maybe; @@ -30970,7 +29741,7 @@ export type VoucherVariantsArgs = { */ export type VoucherAddCatalogues = { __typename?: 'VoucherAddCatalogues'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; /** Voucher of which catalogue IDs will be modified. */ @@ -30989,7 +29760,7 @@ export type VoucherBulkDelete = { __typename?: 'VoucherBulkDelete'; /** Returns how many objects were affected. */ count: Scalars['Int']['output']; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; }; @@ -31035,7 +29806,7 @@ export type VoucherChannelListingInput = { */ export type VoucherChannelListingUpdate = { __typename?: 'VoucherChannelListingUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; /** An updated voucher instance. */ @@ -31092,7 +29863,6 @@ export type VoucherCodeBulkDeleteError = { voucherCodes?: Maybe>; }; -/** An enumeration. */ export enum VoucherCodeBulkDeleteErrorCode { GraphqlError = 'GRAPHQL_ERROR', Invalid = 'INVALID', @@ -31201,17 +29971,13 @@ export type VoucherCountableEdge = { */ export type VoucherCreate = { __typename?: 'VoucherCreate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; voucher?: Maybe; }; -/** - * Event sent when new voucher is created. - * - * Added in Saleor 3.4. - */ +/** Event sent when new voucher is created. */ export type VoucherCreated = Event & { __typename?: 'VoucherCreated'; /** Time of the event. */ @@ -31227,11 +29993,7 @@ export type VoucherCreated = Event & { }; -/** - * Event sent when new voucher is created. - * - * Added in Saleor 3.4. - */ +/** Event sent when new voucher is created. */ export type VoucherCreatedVoucherArgs = { channel?: InputMaybe; }; @@ -31246,17 +30008,13 @@ export type VoucherCreatedVoucherArgs = { */ export type VoucherDelete = { __typename?: 'VoucherDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; voucher?: Maybe; }; -/** - * Event sent when voucher is deleted. - * - * Added in Saleor 3.4. - */ +/** Event sent when voucher is deleted. */ export type VoucherDeleted = Event & { __typename?: 'VoucherDeleted'; /** Time of the event. */ @@ -31272,11 +30030,7 @@ export type VoucherDeleted = Event & { }; -/** - * Event sent when voucher is deleted. - * - * Added in Saleor 3.4. - */ +/** Event sent when voucher is deleted. */ export type VoucherDeletedVoucherArgs = { channel?: InputMaybe; }; @@ -31312,7 +30066,10 @@ export type VoucherInput = { applyOncePerOrder?: InputMaybe; /** Categories discounted by the voucher. */ categories?: InputMaybe>; - /** Code to use the voucher. This field will be removed in Saleor 4.0. Use `addCodes` instead. */ + /** + * Code to use the voucher. + * @deprecated Use `addCodes` instead. + */ code?: InputMaybe; /** Collections discounted by the voucher. */ collections?: InputMaybe>; @@ -31346,19 +30103,11 @@ export type VoucherInput = { type?: InputMaybe; /** Limit number of times this voucher can be used in total. */ usageLimit?: InputMaybe; - /** - * Variants discounted by the voucher. - * - * Added in Saleor 3.1. - */ + /** Variants discounted by the voucher. */ variants?: InputMaybe>; }; -/** - * Event sent when voucher metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when voucher metadata is updated. */ export type VoucherMetadataUpdated = Event & { __typename?: 'VoucherMetadataUpdated'; /** Time of the event. */ @@ -31374,11 +30123,7 @@ export type VoucherMetadataUpdated = Event & { }; -/** - * Event sent when voucher metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when voucher metadata is updated. */ export type VoucherMetadataUpdatedVoucherArgs = { channel?: InputMaybe; }; @@ -31393,7 +30138,7 @@ export type VoucherMetadataUpdatedVoucherArgs = { */ export type VoucherRemoveCatalogues = { __typename?: 'VoucherRemoveCatalogues'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; /** Voucher of which catalogue IDs will be modified. */ @@ -31403,8 +30148,7 @@ export type VoucherRemoveCatalogues = { export enum VoucherSortField { /** * Sort vouchers by code. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ Code = 'CODE', /** Sort vouchers by end date. */ @@ -31438,8 +30182,7 @@ export enum VoucherSortField { export type VoucherSortingInput = { /** * Specifies the channel in which to sort the data. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. + * @deprecated Use root-level channel argument instead. */ channel?: InputMaybe; /** Specifies the direction in which to sort vouchers. */ @@ -31461,14 +30204,10 @@ export type VoucherTranslatableContent = Node & { * 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. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ voucher?: Maybe; - /** - * The ID of the voucher to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the voucher to translate. */ voucherId: Scalars['ID']['output']; }; @@ -31486,7 +30225,7 @@ export type VoucherTranslatableContentTranslationArgs = { export type VoucherTranslate = { __typename?: 'VoucherTranslate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; voucher?: Maybe; }; @@ -31500,11 +30239,7 @@ export type VoucherTranslation = Node & { language: LanguageDisplay; /** Translated voucher name. */ name?: Maybe; - /** - * Represents the voucher fields to translate. - * - * Added in Saleor 3.14. - */ + /** Represents the voucher fields to translate. */ translatableContent?: Maybe; }; @@ -31525,17 +30260,13 @@ export enum VoucherTypeEnum { */ export type VoucherUpdate = { __typename?: 'VoucherUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; voucher?: Maybe; }; -/** - * Event sent when voucher is updated. - * - * Added in Saleor 3.4. - */ +/** Event sent when voucher is updated. */ export type VoucherUpdated = Event & { __typename?: 'VoucherUpdated'; /** Time of the event. */ @@ -31551,11 +30282,7 @@ export type VoucherUpdated = Event & { }; -/** - * Event sent when voucher is updated. - * - * Added in Saleor 3.4. - */ +/** Event sent when voucher is updated. */ export type VoucherUpdatedVoucherArgs = { channel?: InputMaybe; }; @@ -31565,24 +30292,16 @@ export type Warehouse = Node & ObjectWithMetadata & { __typename?: 'Warehouse'; /** Address of the warehouse. */ address: Address; - /** - * Click and collect options: local, all or disabled. - * - * Added in Saleor 3.1. - */ + /** Click and collect options: local, all or disabled. */ clickAndCollectOption: WarehouseClickAndCollectOptionEnum; /** * Warehouse company name. - * @deprecated This field will be removed in Saleor 4.0. Use `Address.companyName` instead. + * @deprecated Use `Address.companyName` instead. */ companyName: Scalars['String']['output']; /** Warehouse email. */ email: Scalars['String']['output']; - /** - * External ID of this warehouse. - * - * Added in Saleor 3.10. - */ + /** External ID of this warehouse. */ externalReference?: Maybe; /** The ID of the warehouse. */ id: Scalars['ID']['output']; @@ -31594,15 +30313,9 @@ export type Warehouse = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Warehouse name. */ name: Scalars['String']['output']; @@ -31612,15 +30325,9 @@ export type Warehouse = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** Shipping zones supported by the warehouse. */ shippingZones: ShippingZoneCountableConnection; @@ -31678,7 +30385,6 @@ export type WarehouseStocksArgs = { last?: InputMaybe; }; -/** An enumeration. */ export enum WarehouseClickAndCollectOptionEnum { All = 'ALL', Disabled = 'DISABLED', @@ -31703,7 +30409,7 @@ export type WarehouseCountableEdge = { }; /** - * Creates new warehouse. + * Creates a new warehouse. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ @@ -31711,7 +30417,7 @@ export type WarehouseCreate = { __typename?: 'WarehouseCreate'; errors: Array; warehouse?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ warehouseErrors: Array; }; @@ -31720,29 +30426,20 @@ export type WarehouseCreateInput = { address: AddressInput; /** The email address of the warehouse. */ email?: InputMaybe; - /** - * External ID of the warehouse. - * - * Added in Saleor 3.10. - */ + /** External ID of the warehouse. */ externalReference?: InputMaybe; /** Warehouse name. */ name: Scalars['String']['input']; /** * Shipping zones supported by the warehouse. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Providing the zone ids will raise a ValidationError. + * @deprecated Providing the zone ids will raise a ValidationError. */ shippingZones?: InputMaybe>; /** Warehouse slug. */ slug?: InputMaybe; }; -/** - * Event sent when new warehouse is created. - * - * Added in Saleor 3.4. - */ +/** Event sent when new warehouse is created. */ export type WarehouseCreated = Event & { __typename?: 'WarehouseCreated'; /** Time of the event. */ @@ -31766,15 +30463,11 @@ export type WarehouseDelete = { __typename?: 'WarehouseDelete'; errors: Array; warehouse?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ warehouseErrors: Array; }; -/** - * Event sent when warehouse is deleted. - * - * Added in Saleor 3.4. - */ +/** Event sent when warehouse is deleted. */ export type WarehouseDeleted = Event & { __typename?: 'WarehouseDeleted'; /** Time of the event. */ @@ -31801,7 +30494,6 @@ export type WarehouseError = { shippingZones?: Maybe>; }; -/** An enumeration. */ export enum WarehouseErrorCode { AlreadyExists = 'ALREADY_EXISTS', GraphqlError = 'GRAPHQL_ERROR', @@ -31821,11 +30513,7 @@ export type WarehouseFilterInput = { slugs?: InputMaybe>; }; -/** - * Event sent when warehouse metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when warehouse metadata is updated. */ export type WarehouseMetadataUpdated = Event & { __typename?: 'WarehouseMetadataUpdated'; /** Time of the event. */ @@ -31849,7 +30537,7 @@ export type WarehouseShippingZoneAssign = { __typename?: 'WarehouseShippingZoneAssign'; errors: Array; warehouse?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ warehouseErrors: Array; }; @@ -31862,7 +30550,7 @@ export type WarehouseShippingZoneUnassign = { __typename?: 'WarehouseShippingZoneUnassign'; errors: Array; warehouse?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ warehouseErrors: Array; }; @@ -31887,32 +30575,20 @@ export type WarehouseUpdate = { __typename?: 'WarehouseUpdate'; errors: Array; warehouse?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ warehouseErrors: Array; }; export type WarehouseUpdateInput = { /** Address of the warehouse. */ address?: InputMaybe; - /** - * Click and collect options: local, all or disabled. - * - * Added in Saleor 3.1. - */ + /** Click and collect options: local, all or disabled. */ clickAndCollectOption?: InputMaybe; /** The email address of the warehouse. */ email?: InputMaybe; - /** - * External ID of the warehouse. - * - * Added in Saleor 3.10. - */ + /** External ID of the warehouse. */ externalReference?: InputMaybe; - /** - * Visibility of warehouse stocks. - * - * Added in Saleor 3.1. - */ + /** Visibility of warehouse stocks. */ isPrivate?: InputMaybe; /** Warehouse name. */ name?: InputMaybe; @@ -31920,11 +30596,7 @@ export type WarehouseUpdateInput = { slug?: InputMaybe; }; -/** - * Event sent when warehouse is updated. - * - * Added in Saleor 3.4. - */ +/** Event sent when warehouse is updated. */ export type WarehouseUpdated = Event & { __typename?: 'WarehouseUpdated'; /** Time of the event. */ @@ -31942,23 +30614,19 @@ export type WarehouseUpdated = Event & { /** Webhook. */ export type Webhook = Node & { __typename?: 'Webhook'; - /** The app associated with Webhook. */ - app: App; - /** List of asynchronous webhook events. */ - asyncEvents: Array; - /** - * Custom headers, which will be added to HTTP request. - * - * Added in Saleor 3.12. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The app associated with Webhook. */ + app: App; + /** List of asynchronous webhook events. */ + asyncEvents: Array; + /** Custom headers, which will be added to HTTP request. */ customHeaders?: Maybe; + /** Conditions under which webhook delivery is deferred. */ + deferIfConditions?: Maybe>; /** Event deliveries. */ eventDeliveries?: Maybe; /** * List of webhook events. - * @deprecated This field will be removed in Saleor 4.0. Use `asyncEvents` or `syncEvents` instead. + * @deprecated Use `asyncEvents` or `syncEvents` instead. */ events: Array; /** The ID of webhook. */ @@ -31969,7 +30637,7 @@ export type Webhook = Node & { name?: Maybe; /** * Used to create a hash signature for each payload. - * @deprecated This field will be removed in Saleor 4.0. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS. + * @deprecated As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS. */ secretKey?: Maybe; /** Used to define payloads for specific events. */ @@ -32000,7 +30668,7 @@ export type WebhookCreate = { __typename?: 'WebhookCreate'; errors: Array; webhook?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ webhookErrors: Array; }; @@ -32009,34 +30677,22 @@ export type WebhookCreateInput = { app?: InputMaybe; /** The asynchronous events that webhook wants to subscribe. */ asyncEvents?: InputMaybe>; - /** - * 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. - * - * Added in Saleor 3.12. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** 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?: InputMaybe; /** * The events that webhook wants to subscribe. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `asyncEvents` or `syncEvents` instead. + * @deprecated Use `asyncEvents` or `syncEvents` instead. */ events?: InputMaybe>; /** Determine if webhook will be set active or not. */ isActive?: InputMaybe; /** The name of the webhook. */ name?: InputMaybe; - /** - * Subscription query used to define a webhook payload. - * - * Added in Saleor 3.2. - */ + /** Subscription query used to define a webhook payload. */ query?: InputMaybe; /** * The secret key used to create a hash signature with each payload. - * - * DEPRECATED: this field will be removed in Saleor 4.0. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS. + * @deprecated As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS. */ secretKey?: InputMaybe; /** The synchronous events that webhook wants to subscribe. */ @@ -32045,8 +30701,13 @@ export type WebhookCreateInput = { targetUrl?: InputMaybe; }; +/** Conditions under which a webhook delivery should be deferred. If any condition evaluates to true, the webhook will not fire. */ +export enum WebhookDeferIfConditionEnum { + AddressMissing = 'ADDRESS_MISSING' +} + /** - * Delete a webhook. Before the deletion, the webhook is deactivated to pause any deliveries that are already scheduled. The deletion might fail if delivery is in progress. In such a case, the webhook is not deleted but remains deactivated. + * 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. * * Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP. */ @@ -32054,17 +30715,13 @@ export type WebhookDelete = { __typename?: 'WebhookDelete'; errors: Array; webhook?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ webhookErrors: Array; }; /** * Performs a dry run of a webhook event. Supports a single event (the first, if multiple provided in the `query`). Requires permission relevant to processed event. * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER. */ export type WebhookDryRun = { @@ -32084,7 +30741,6 @@ export type WebhookDryRunError = { message?: Maybe; }; -/** An enumeration. */ export enum WebhookDryRunErrorCode { GraphqlError = 'GRAPHQL_ERROR', InvalidId = 'INVALID_ID', @@ -32107,7 +30763,6 @@ export type WebhookError = { message?: Maybe; }; -/** An enumeration. */ export enum WebhookErrorCode { DeleteFailed = 'DELETE_FAILED', GraphqlError = 'GRAPHQL_ERROR', @@ -32174,8 +30829,7 @@ export enum WebhookEventTypeAsyncEnum { AddressUpdated = 'ADDRESS_UPDATED', /** * All the events. - * - * DEPRECATED: this value will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ AnyEvents = 'ANY_EVENTS', /** An app deleted. */ @@ -32216,12 +30870,19 @@ export enum WebhookEventTypeAsyncEnum { ChannelUpdated = 'CHANNEL_UPDATED', /** A new checkout is created. */ CheckoutCreated = 'CHECKOUT_CREATED', - CheckoutFullyPaid = 'CHECKOUT_FULLY_PAID', /** - * A checkout metadata is updated. + * A checkout was fully authorized (its `authorizeStatus` is `FULL`). + * + * This event is emitted only for checkouts whose payments are processed through the Transaction API. + */ + CheckoutFullyAuthorized = 'CHECKOUT_FULLY_AUTHORIZED', + /** + * A checkout was fully paid (its `chargeStatus` is `FULL` or `OVERCHARGED`). This event is not sent if payments are only authorized but not fully charged. * - * Added in Saleor 3.8. + * This event is emitted only for checkouts whose payments are processed through the Transaction API. */ + CheckoutFullyPaid = 'CHECKOUT_FULLY_PAID', + /** A checkout metadata is updated. */ CheckoutMetadataUpdated = 'CHECKOUT_METADATA_UPDATED', /** A checkout is updated. It also triggers all updates related to the checkout. */ CheckoutUpdated = 'CHECKOUT_UPDATED', @@ -32229,11 +30890,7 @@ export enum WebhookEventTypeAsyncEnum { CollectionCreated = 'COLLECTION_CREATED', /** A collection is deleted. */ CollectionDeleted = 'COLLECTION_DELETED', - /** - * A collection metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A collection metadata is updated. */ CollectionMetadataUpdated = 'COLLECTION_METADATA_UPDATED', /** A collection is updated. */ CollectionUpdated = 'COLLECTION_UPDATED', @@ -32241,11 +30898,7 @@ export enum WebhookEventTypeAsyncEnum { CustomerCreated = 'CUSTOMER_CREATED', /** A customer account is deleted. */ CustomerDeleted = 'CUSTOMER_DELETED', - /** - * A customer account metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A customer account metadata is updated. */ CustomerMetadataUpdated = 'CUSTOMER_METADATA_UPDATED', /** A customer account is updated. */ CustomerUpdated = 'CUSTOMER_UPDATED', @@ -32261,36 +30914,18 @@ export enum WebhookEventTypeAsyncEnum { FulfillmentCanceled = 'FULFILLMENT_CANCELED', /** A new fulfillment is created. */ FulfillmentCreated = 'FULFILLMENT_CREATED', - /** - * A fulfillment metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A fulfillment metadata is updated. */ FulfillmentMetadataUpdated = 'FULFILLMENT_METADATA_UPDATED', FulfillmentTrackingNumberUpdated = 'FULFILLMENT_TRACKING_NUMBER_UPDATED', /** A new gift card created. */ GiftCardCreated = 'GIFT_CARD_CREATED', /** A gift card is deleted. */ GiftCardDeleted = 'GIFT_CARD_DELETED', - /** - * A gift card export is completed. - * - * Added in Saleor 3.16. - */ + /** A gift card export is completed. */ GiftCardExportCompleted = 'GIFT_CARD_EXPORT_COMPLETED', - /** - * A gift card metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A gift card metadata is updated. */ GiftCardMetadataUpdated = 'GIFT_CARD_METADATA_UPDATED', - /** - * A gift card has been sent. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** A gift card has been sent. */ GiftCardSent = 'GIFT_CARD_SENT', /** A gift card status is changed. */ GiftCardStatusChanged = 'GIFT_CARD_STATUS_CHANGED', @@ -32316,19 +30951,12 @@ export enum WebhookEventTypeAsyncEnum { MenuUpdated = 'MENU_UPDATED', /** * User notification triggered. - * - * DEPRECATED: this value will be removed in Saleor 4.0. See the docs for more details about migrating from NOTIFY_USER to other events: https://docs.saleor.io/docs/next/upgrade-guides/notify-user-deprecation + * @deprecated See the docs for more details about migrating from NOTIFY_USER to other events: https://docs.saleor.io/upgrade-guides/core/3-16-to-3-17#migrating-from-notify_user */ NotifyUser = 'NOTIFY_USER', /** An observability event is created. */ Observability = 'OBSERVABILITY', - /** - * Orders are imported. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Orders are imported. */ OrderBulkCreated = 'ORDER_BULK_CREATED', /** An order is cancelled. */ OrderCancelled = 'ORDER_CANCELLED', @@ -32342,35 +30970,13 @@ export enum WebhookEventTypeAsyncEnum { OrderFulfilled = 'ORDER_FULFILLED', /** Payment is made and an order is fully paid. */ OrderFullyPaid = 'ORDER_FULLY_PAID', - /** - * The order is fully refunded. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The order is fully refunded. */ OrderFullyRefunded = 'ORDER_FULLY_REFUNDED', - /** - * An order metadata is updated. - * - * Added in Saleor 3.8. - */ + /** An order metadata is updated. */ OrderMetadataUpdated = 'ORDER_METADATA_UPDATED', - /** - * Payment has been made. The order may be partially or fully paid. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Payment has been made. The order may be partially or fully paid. */ OrderPaid = 'ORDER_PAID', - /** - * The order received a refund. The order may be partially or fully refunded. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The order received a refund. The order may be partially or fully refunded. */ OrderRefunded = 'ORDER_REFUNDED', /** An order is updated; triggered for all changes related to an order; covers all other order webhooks, except for ORDER_CREATED. */ OrderUpdated = 'ORDER_UPDATED', @@ -32396,35 +31002,15 @@ export enum WebhookEventTypeAsyncEnum { ProductCreated = 'PRODUCT_CREATED', /** A product is deleted. */ ProductDeleted = 'PRODUCT_DELETED', - /** - * A product export is completed. - * - * Added in Saleor 3.16. - */ + /** A product export is completed. */ ProductExportCompleted = 'PRODUCT_EXPORT_COMPLETED', - /** - * A new product media is created. - * - * Added in Saleor 3.12. - */ + /** A new product media is created. */ ProductMediaCreated = 'PRODUCT_MEDIA_CREATED', - /** - * A product media is deleted. - * - * Added in Saleor 3.12. - */ + /** A product media is deleted. */ ProductMediaDeleted = 'PRODUCT_MEDIA_DELETED', - /** - * A product media is updated. - * - * Added in Saleor 3.12. - */ + /** A product media is updated. */ ProductMediaUpdated = 'PRODUCT_MEDIA_UPDATED', - /** - * A product metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A product metadata is updated. */ ProductMetadataUpdated = 'PRODUCT_METADATA_UPDATED', /** A product is updated. */ ProductUpdated = 'PRODUCT_UPDATED', @@ -32434,11 +31020,7 @@ export enum WebhookEventTypeAsyncEnum { ProductVariantCreated = 'PRODUCT_VARIANT_CREATED', /** A product variant is deleted. Warning: this event will not be executed when parent product has been deleted. Check PRODUCT_DELETED. */ ProductVariantDeleted = 'PRODUCT_VARIANT_DELETED', - /** - * A product variant metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A product variant metadata is updated. */ ProductVariantMetadataUpdated = 'PRODUCT_VARIANT_METADATA_UPDATED', /** A product variant is out of stock. */ ProductVariantOutOfStock = 'PRODUCT_VARIANT_OUT_OF_STOCK', @@ -32480,19 +31062,11 @@ export enum WebhookEventTypeAsyncEnum { ShippingZoneCreated = 'SHIPPING_ZONE_CREATED', /** A shipping zone is deleted. */ ShippingZoneDeleted = 'SHIPPING_ZONE_DELETED', - /** - * A shipping zone metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A shipping zone metadata is updated. */ ShippingZoneMetadataUpdated = 'SHIPPING_ZONE_METADATA_UPDATED', /** A shipping zone is updated. */ ShippingZoneUpdated = 'SHIPPING_ZONE_UPDATED', - /** - * Shop metadata is updated. - * - * Added in Saleor 3.15. - */ + /** Shop metadata is updated. */ ShopMetadataUpdated = 'SHOP_METADATA_UPDATED', /** A new staff user is created. */ StaffCreated = 'STAFF_CREATED', @@ -32502,17 +31076,9 @@ export enum WebhookEventTypeAsyncEnum { StaffSetPasswordRequested = 'STAFF_SET_PASSWORD_REQUESTED', /** A staff user is updated. */ StaffUpdated = 'STAFF_UPDATED', - /** - * A thumbnail is created. - * - * Added in Saleor 3.12. - */ + /** A thumbnail is created. */ ThumbnailCreated = 'THUMBNAIL_CREATED', - /** - * Transaction item metadata is updated. - * - * Added in Saleor 3.8. - */ + /** Transaction item metadata is updated. */ TransactionItemMetadataUpdated = 'TRANSACTION_ITEM_METADATA_UPDATED', /** A new translation is created. */ TranslationCreated = 'TRANSLATION_CREATED', @@ -32530,11 +31096,7 @@ export enum WebhookEventTypeAsyncEnum { VoucherCreated = 'VOUCHER_CREATED', /** A voucher is deleted. */ VoucherDeleted = 'VOUCHER_DELETED', - /** - * A voucher metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A voucher metadata is updated. */ VoucherMetadataUpdated = 'VOUCHER_METADATA_UPDATED', /** A voucher is updated. */ VoucherUpdated = 'VOUCHER_UPDATED', @@ -32542,11 +31104,7 @@ export enum WebhookEventTypeAsyncEnum { WarehouseCreated = 'WAREHOUSE_CREATED', /** A warehouse is deleted. */ WarehouseDeleted = 'WAREHOUSE_DELETED', - /** - * A warehouse metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A warehouse metadata is updated. */ WarehouseMetadataUpdated = 'WAREHOUSE_METADATA_UPDATED', /** A warehouse is updated. */ WarehouseUpdated = 'WAREHOUSE_UPDATED' @@ -32576,8 +31134,7 @@ export enum WebhookEventTypeEnum { AddressUpdated = 'ADDRESS_UPDATED', /** * All the events. - * - * DEPRECATED: this value will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ AnyEvents = 'ANY_EVENTS', /** An app deleted. */ @@ -32616,22 +31173,25 @@ export enum WebhookEventTypeEnum { ChannelStatusChanged = 'CHANNEL_STATUS_CHANGED', /** A channel is updated. */ ChannelUpdated = 'CHANNEL_UPDATED', - /** - * Event called for checkout tax calculation. - * - * Added in Saleor 3.6. - */ + /** Event called for checkout tax calculation. */ CheckoutCalculateTaxes = 'CHECKOUT_CALCULATE_TAXES', /** A new checkout is created. */ CheckoutCreated = 'CHECKOUT_CREATED', /** Filter shipping methods for checkout. */ CheckoutFilterShippingMethods = 'CHECKOUT_FILTER_SHIPPING_METHODS', - CheckoutFullyPaid = 'CHECKOUT_FULLY_PAID', /** - * A checkout metadata is updated. + * A checkout was fully authorized (its `authorizeStatus` is `FULL`). + * + * This event is emitted only for checkouts whose payments are processed through the Transaction API. + */ + CheckoutFullyAuthorized = 'CHECKOUT_FULLY_AUTHORIZED', + /** + * A checkout was fully paid (its `chargeStatus` is `FULL` or `OVERCHARGED`). This event is not sent if payments are only authorized but not fully charged. * - * Added in Saleor 3.8. + * This event is emitted only for checkouts whose payments are processed through the Transaction API. */ + CheckoutFullyPaid = 'CHECKOUT_FULLY_PAID', + /** A checkout metadata is updated. */ CheckoutMetadataUpdated = 'CHECKOUT_METADATA_UPDATED', /** A checkout is updated. It also triggers all updates related to the checkout. */ CheckoutUpdated = 'CHECKOUT_UPDATED', @@ -32639,11 +31199,7 @@ export enum WebhookEventTypeEnum { CollectionCreated = 'COLLECTION_CREATED', /** A collection is deleted. */ CollectionDeleted = 'COLLECTION_DELETED', - /** - * A collection metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A collection metadata is updated. */ CollectionMetadataUpdated = 'COLLECTION_METADATA_UPDATED', /** A collection is updated. */ CollectionUpdated = 'COLLECTION_UPDATED', @@ -32651,11 +31207,7 @@ export enum WebhookEventTypeEnum { CustomerCreated = 'CUSTOMER_CREATED', /** A customer account is deleted. */ CustomerDeleted = 'CUSTOMER_DELETED', - /** - * A customer account metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A customer account metadata is updated. */ CustomerMetadataUpdated = 'CUSTOMER_METADATA_UPDATED', /** A customer account is updated. */ CustomerUpdated = 'CUSTOMER_UPDATED', @@ -32671,36 +31223,18 @@ export enum WebhookEventTypeEnum { FulfillmentCanceled = 'FULFILLMENT_CANCELED', /** A new fulfillment is created. */ FulfillmentCreated = 'FULFILLMENT_CREATED', - /** - * A fulfillment metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A fulfillment metadata is updated. */ FulfillmentMetadataUpdated = 'FULFILLMENT_METADATA_UPDATED', FulfillmentTrackingNumberUpdated = 'FULFILLMENT_TRACKING_NUMBER_UPDATED', /** A new gift card created. */ GiftCardCreated = 'GIFT_CARD_CREATED', /** A gift card is deleted. */ GiftCardDeleted = 'GIFT_CARD_DELETED', - /** - * A gift card export is completed. - * - * Added in Saleor 3.16. - */ + /** A gift card export is completed. */ GiftCardExportCompleted = 'GIFT_CARD_EXPORT_COMPLETED', - /** - * A gift card metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A gift card metadata is updated. */ GiftCardMetadataUpdated = 'GIFT_CARD_METADATA_UPDATED', - /** - * A gift card has been sent. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** A gift card has been sent. */ GiftCardSent = 'GIFT_CARD_SENT', /** A gift card status is changed. */ GiftCardStatusChanged = 'GIFT_CARD_STATUS_CHANGED', @@ -32727,25 +31261,14 @@ export enum WebhookEventTypeEnum { MenuUpdated = 'MENU_UPDATED', /** * User notification triggered. - * - * DEPRECATED: this value will be removed in Saleor 4.0. See the docs for more details about migrating from NOTIFY_USER to other events: https://docs.saleor.io/docs/next/upgrade-guides/notify-user-deprecation + * @deprecated See the docs for more details about migrating from NOTIFY_USER to other events: https://docs.saleor.io/upgrade-guides/core/3-16-to-3-17#migrating-from-notify_user */ NotifyUser = 'NOTIFY_USER', /** An observability event is created. */ Observability = 'OBSERVABILITY', - /** - * Orders are imported. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Orders are imported. */ OrderBulkCreated = 'ORDER_BULK_CREATED', - /** - * Event called for order tax calculation. - * - * Added in Saleor 3.6. - */ + /** Event called for order tax calculation. */ OrderCalculateTaxes = 'ORDER_CALCULATE_TAXES', /** An order is cancelled. */ OrderCancelled = 'ORDER_CANCELLED', @@ -32761,35 +31284,13 @@ export enum WebhookEventTypeEnum { OrderFulfilled = 'ORDER_FULFILLED', /** Payment is made and an order is fully paid. */ OrderFullyPaid = 'ORDER_FULLY_PAID', - /** - * The order is fully refunded. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The order is fully refunded. */ OrderFullyRefunded = 'ORDER_FULLY_REFUNDED', - /** - * An order metadata is updated. - * - * Added in Saleor 3.8. - */ + /** An order metadata is updated. */ OrderMetadataUpdated = 'ORDER_METADATA_UPDATED', - /** - * Payment has been made. The order may be partially or fully paid. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Payment has been made. The order may be partially or fully paid. */ OrderPaid = 'ORDER_PAID', - /** - * The order received a refund. The order may be partially or fully refunded. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The order received a refund. The order may be partially or fully refunded. */ OrderRefunded = 'ORDER_REFUNDED', /** An order is updated; triggered for all changes related to an order; covers all other order webhooks, except for ORDER_CREATED. */ OrderUpdated = 'ORDER_UPDATED', @@ -32833,35 +31334,15 @@ export enum WebhookEventTypeEnum { ProductCreated = 'PRODUCT_CREATED', /** A product is deleted. */ ProductDeleted = 'PRODUCT_DELETED', - /** - * A product export is completed. - * - * Added in Saleor 3.16. - */ + /** A product export is completed. */ ProductExportCompleted = 'PRODUCT_EXPORT_COMPLETED', - /** - * A new product media is created. - * - * Added in Saleor 3.12. - */ + /** A new product media is created. */ ProductMediaCreated = 'PRODUCT_MEDIA_CREATED', - /** - * A product media is deleted. - * - * Added in Saleor 3.12. - */ + /** A product media is deleted. */ ProductMediaDeleted = 'PRODUCT_MEDIA_DELETED', - /** - * A product media is updated. - * - * Added in Saleor 3.12. - */ + /** A product media is updated. */ ProductMediaUpdated = 'PRODUCT_MEDIA_UPDATED', - /** - * A product metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A product metadata is updated. */ ProductMetadataUpdated = 'PRODUCT_METADATA_UPDATED', /** A product is updated. */ ProductUpdated = 'PRODUCT_UPDATED', @@ -32871,11 +31352,7 @@ export enum WebhookEventTypeEnum { ProductVariantCreated = 'PRODUCT_VARIANT_CREATED', /** A product variant is deleted. Warning: this event will not be executed when parent product has been deleted. Check PRODUCT_DELETED. */ ProductVariantDeleted = 'PRODUCT_VARIANT_DELETED', - /** - * A product variant metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A product variant metadata is updated. */ ProductVariantMetadataUpdated = 'PRODUCT_VARIANT_METADATA_UPDATED', /** A product variant is out of stock. */ ProductVariantOutOfStock = 'PRODUCT_VARIANT_OUT_OF_STOCK', @@ -32919,19 +31396,11 @@ export enum WebhookEventTypeEnum { ShippingZoneCreated = 'SHIPPING_ZONE_CREATED', /** A shipping zone is deleted. */ ShippingZoneDeleted = 'SHIPPING_ZONE_DELETED', - /** - * A shipping zone metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A shipping zone metadata is updated. */ ShippingZoneMetadataUpdated = 'SHIPPING_ZONE_METADATA_UPDATED', /** A shipping zone is updated. */ ShippingZoneUpdated = 'SHIPPING_ZONE_UPDATED', - /** - * Shop metadata is updated. - * - * Added in Saleor 3.15. - */ + /** Shop metadata is updated. */ ShopMetadataUpdated = 'SHOP_METADATA_UPDATED', /** A new staff user is created. */ StaffCreated = 'STAFF_CREATED', @@ -32942,43 +31411,17 @@ export enum WebhookEventTypeEnum { /** A staff user is updated. */ StaffUpdated = 'STAFF_UPDATED', StoredPaymentMethodDeleteRequested = 'STORED_PAYMENT_METHOD_DELETE_REQUESTED', - /** - * A thumbnail is created. - * - * Added in Saleor 3.12. - */ + /** A thumbnail is created. */ ThumbnailCreated = 'THUMBNAIL_CREATED', - /** - * Event called when cancel has been requested for transaction. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Event called when cancel has been requested for transaction. */ TransactionCancelationRequested = 'TRANSACTION_CANCELATION_REQUESTED', - /** - * Event called when charge has been requested for transaction. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Event called when charge has been requested for transaction. */ TransactionChargeRequested = 'TRANSACTION_CHARGE_REQUESTED', TransactionInitializeSession = 'TRANSACTION_INITIALIZE_SESSION', - /** - * Transaction item metadata is updated. - * - * Added in Saleor 3.8. - */ + /** Transaction item metadata is updated. */ TransactionItemMetadataUpdated = 'TRANSACTION_ITEM_METADATA_UPDATED', TransactionProcessSession = 'TRANSACTION_PROCESS_SESSION', - /** - * Event called when refund has been requested for transaction. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Event called when refund has been requested for transaction. */ TransactionRefundRequested = 'TRANSACTION_REFUND_REQUESTED', /** A new translation is created. */ TranslationCreated = 'TRANSLATION_CREATED', @@ -32996,11 +31439,7 @@ export enum WebhookEventTypeEnum { VoucherCreated = 'VOUCHER_CREATED', /** A voucher is deleted. */ VoucherDeleted = 'VOUCHER_DELETED', - /** - * A voucher metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A voucher metadata is updated. */ VoucherMetadataUpdated = 'VOUCHER_METADATA_UPDATED', /** A voucher is updated. */ VoucherUpdated = 'VOUCHER_UPDATED', @@ -33008,11 +31447,7 @@ export enum WebhookEventTypeEnum { WarehouseCreated = 'WAREHOUSE_CREATED', /** A warehouse is deleted. */ WarehouseDeleted = 'WAREHOUSE_DELETED', - /** - * A warehouse metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A warehouse metadata is updated. */ WarehouseMetadataUpdated = 'WAREHOUSE_METADATA_UPDATED', /** A warehouse is updated. */ WarehouseUpdated = 'WAREHOUSE_UPDATED' @@ -33020,20 +31455,12 @@ export enum WebhookEventTypeEnum { /** Enum determining type of webhook. */ export enum WebhookEventTypeSyncEnum { - /** - * Event called for checkout tax calculation. - * - * Added in Saleor 3.6. - */ + /** Event called for checkout tax calculation. */ CheckoutCalculateTaxes = 'CHECKOUT_CALCULATE_TAXES', /** Filter shipping methods for checkout. */ CheckoutFilterShippingMethods = 'CHECKOUT_FILTER_SHIPPING_METHODS', ListStoredPaymentMethods = 'LIST_STORED_PAYMENT_METHODS', - /** - * Event called for order tax calculation. - * - * Added in Saleor 3.6. - */ + /** Event called for order tax calculation. */ OrderCalculateTaxes = 'ORDER_CALCULATE_TAXES', /** Filter shipping methods for order. */ OrderFilterShippingMethods = 'ORDER_FILTER_SHIPPING_METHODS', @@ -33058,35 +31485,16 @@ export enum WebhookEventTypeSyncEnum { /** Fetch external shipping methods for checkout. */ ShippingListMethodsForCheckout = 'SHIPPING_LIST_METHODS_FOR_CHECKOUT', StoredPaymentMethodDeleteRequested = 'STORED_PAYMENT_METHOD_DELETE_REQUESTED', - /** - * Event called when cancel has been requested for transaction. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Event called when cancel has been requested for transaction. */ TransactionCancelationRequested = 'TRANSACTION_CANCELATION_REQUESTED', - /** - * Event called when charge has been requested for transaction. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Event called when charge has been requested for transaction. */ TransactionChargeRequested = 'TRANSACTION_CHARGE_REQUESTED', TransactionInitializeSession = 'TRANSACTION_INITIALIZE_SESSION', TransactionProcessSession = 'TRANSACTION_PROCESS_SESSION', - /** - * Event called when refund has been requested for transaction. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Event called when refund has been requested for transaction. */ TransactionRefundRequested = 'TRANSACTION_REFUND_REQUESTED' } -/** An enumeration. */ export enum WebhookSampleEventTypeEnum { AccountChangeEmailRequested = 'ACCOUNT_CHANGE_EMAIL_REQUESTED', AccountConfirmationRequested = 'ACCOUNT_CONFIRMATION_REQUESTED', @@ -33117,6 +31525,7 @@ export enum WebhookSampleEventTypeEnum { ChannelStatusChanged = 'CHANNEL_STATUS_CHANGED', ChannelUpdated = 'CHANNEL_UPDATED', CheckoutCreated = 'CHECKOUT_CREATED', + CheckoutFullyAuthorized = 'CHECKOUT_FULLY_AUTHORIZED', CheckoutFullyPaid = 'CHECKOUT_FULLY_PAID', CheckoutMetadataUpdated = 'CHECKOUT_METADATA_UPDATED', CheckoutUpdated = 'CHECKOUT_UPDATED', @@ -33234,10 +31643,6 @@ export enum WebhookSampleEventTypeEnum { /** * Trigger a webhook event. Supports a single event (the first, if multiple provided in the `webhook.subscription_query`). Requires permission relevant to processed event. Successfully delivered webhook returns `delivery` with status='PENDING' and empty payload. * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER. */ export type WebhookTrigger = { @@ -33256,7 +31661,6 @@ export type WebhookTriggerError = { message?: Maybe; }; -/** An enumeration. */ export enum WebhookTriggerErrorCode { GraphqlError = 'GRAPHQL_ERROR', InvalidId = 'INVALID_ID', @@ -33279,7 +31683,7 @@ export type WebhookUpdate = { __typename?: 'WebhookUpdate'; errors: Array; webhook?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ webhookErrors: Array; }; @@ -33288,34 +31692,22 @@ export type WebhookUpdateInput = { app?: InputMaybe; /** The asynchronous events that webhook wants to subscribe. */ asyncEvents?: InputMaybe>; - /** - * 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. - * - * Added in Saleor 3.12. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** 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?: InputMaybe; /** * The events that webhook wants to subscribe. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `asyncEvents` or `syncEvents` instead. + * @deprecated Use `asyncEvents` or `syncEvents` instead. */ events?: InputMaybe>; /** Determine if webhook will be set active or not. */ isActive?: InputMaybe; /** The new name of the webhook. */ name?: InputMaybe; - /** - * Subscription query used to define a webhook payload. - * - * Added in Saleor 3.2. - */ + /** Subscription query used to define a webhook payload. */ query?: InputMaybe; /** * Use to create a hash signature with each payload. - * - * DEPRECATED: this field will be removed in Saleor 4.0. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS. + * @deprecated As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS. */ secretKey?: InputMaybe; /** The synchronous events that webhook wants to subscribe. */ @@ -33333,7 +31725,6 @@ export type Weight = { value: Scalars['Float']['output']; }; -/** An enumeration. */ export enum WeightUnitsEnum { G = 'G', Kg = 'KG', @@ -33342,6 +31733,16 @@ export enum WeightUnitsEnum { Tonne = 'TONNE' } +/** Represents the WIDGET target options for an app extension. */ +export type WidgetTargetOptions = { + __typename?: 'WidgetTargetOptions'; + /** + * HTTP method for Widget target (GET or POST) + * @deprecated Use `settings` field directly. + */ + method: HttpMethod; +}; + /** _Entity union as defined by Federation spec. */ export type _Entity = Address | App | Category | Collection | Group | Order | PageType | Product | ProductMedia | ProductType | ProductVariant | User; diff --git a/apps/avatax/generated/graphql.ts b/apps/avatax/generated/graphql.ts index a3975d5f3b..20488de98b 100644 --- a/apps/avatax/generated/graphql.ts +++ b/apps/avatax/generated/graphql.ts @@ -43,6 +43,8 @@ export type Scalars = { * String, Boolean, Int, Float, List or Object. */ GenericScalar: { input: JSONValue; output: JSONValue; } + /** The `Hour` scalar type represents number of hours by integer value. */ + Hour: { input: number; output: number; } JSON: { input: JSONValue; output: JSONValue; } JSONString: { input: string; output: string; } /** @@ -65,6 +67,12 @@ export type Scalars = { * Should be used in places where value must be nonnegative (0 or greater). */ PositiveDecimal: { input: number; output: number; } + /** + * Positive Integer scalar implementation. + * + * Should be used in places where value must be positive (greater than 0). + */ + PositiveInt: { input: number; output: number; } UUID: { input: string; output: string; } /** Variables of this type must be set to null in mutations. They will be replaced with a filename from a following multipart part containing a binary file. See: https://github.com/jaydenseric/graphql-multipart-request-spec. */ Upload: { input: unknown; output: unknown; } @@ -84,7 +92,7 @@ export type Scalars = { */ export type AccountAddressCreate = { __typename?: 'AccountAddressCreate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; address?: Maybe
; errors: Array; @@ -93,14 +101,14 @@ export type AccountAddressCreate = { }; /** - * Delete an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER. + * Deletes an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER. * * Triggers the following webhook events: * - ADDRESS_DELETED (async): An address was deleted. */ export type AccountAddressDelete = { __typename?: 'AccountAddressDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; address?: Maybe
; errors: Array; @@ -116,7 +124,7 @@ export type AccountAddressDelete = { */ export type AccountAddressUpdate = { __typename?: 'AccountAddressUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; address?: Maybe
; errors: Array; @@ -124,11 +132,7 @@ export type AccountAddressUpdate = { user?: Maybe; }; -/** - * Event sent when account change email is requested. - * - * Added in Saleor 3.15. - */ +/** Event sent when account change email is requested. */ export type AccountChangeEmailRequested = Event & { __typename?: 'AccountChangeEmailRequested'; /** The channel data. */ @@ -153,11 +157,7 @@ export type AccountChangeEmailRequested = Event & { version?: Maybe; }; -/** - * Event sent when account confirmation requested. This event is always sent. enableAccountConfirmationByEmail flag set to True is not required. - * - * Added in Saleor 3.15. - */ +/** Event sent when account confirmation requested. This event is always sent. enableAccountConfirmationByEmail flag set to True is not required. */ export type AccountConfirmationRequested = Event & { __typename?: 'AccountConfirmationRequested'; /** The channel data. */ @@ -180,11 +180,7 @@ export type AccountConfirmationRequested = Event & { version?: Maybe; }; -/** - * Event sent when account is confirmed. - * - * Added in Saleor 3.15. - */ +/** Event sent when account is confirmed. */ export type AccountConfirmed = Event & { __typename?: 'AccountConfirmed'; /** The channel data. */ @@ -217,17 +213,13 @@ export type AccountConfirmed = Event & { */ export type AccountDelete = { __typename?: 'AccountDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; user?: Maybe; }; -/** - * Event sent when account delete is requested. - * - * Added in Saleor 3.15. - */ +/** Event sent when account delete is requested. */ export type AccountDeleteRequested = Event & { __typename?: 'AccountDeleteRequested'; /** The channel data. */ @@ -250,11 +242,7 @@ export type AccountDeleteRequested = Event & { version?: Maybe; }; -/** - * Event sent when account is deleted. - * - * Added in Saleor 3.15. - */ +/** Event sent when account is deleted. */ export type AccountDeleted = Event & { __typename?: 'AccountDeleted'; /** The channel data. */ @@ -277,11 +265,7 @@ export type AccountDeleted = Event & { version?: Maybe; }; -/** - * Event sent when account email is changed. - * - * Added in Saleor 3.15. - */ +/** Event sent when account email is changed. */ export type AccountEmailChanged = Event & { __typename?: 'AccountEmailChanged'; /** The channel data. */ @@ -319,7 +303,6 @@ export type AccountError = { message?: Maybe; }; -/** An enumeration. */ export type AccountErrorCode = | 'ACCOUNT_NOT_CONFIRMED' | 'ACTIVATE_OWN_ACCOUNT' @@ -371,9 +354,9 @@ export type AccountInput = { /** Family name. */ lastName?: InputMaybe; /** - * Fields required to update the user metadata. + * Fields required to update the user metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; }; @@ -388,11 +371,12 @@ export type AccountInput = { */ export type AccountRegister = { __typename?: 'AccountRegister'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** Informs whether users need to confirm their email address. */ requiresConfirmation?: Maybe; + /** @deprecated 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. */ user?: Maybe; }; @@ -408,7 +392,11 @@ export type AccountRegisterInput = { languageCode?: InputMaybe; /** Family name. */ lastName?: InputMaybe; - /** User public metadata. */ + /** + * User public metadata. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ metadata?: InputMaybe>; /** Password. */ password: Scalars['String']['input']; @@ -427,7 +415,7 @@ export type AccountRegisterInput = { */ export type AccountRequestDeletion = { __typename?: 'AccountRequestDeletion'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; }; @@ -442,18 +430,14 @@ export type AccountRequestDeletion = { */ export type AccountSetDefaultAddress = { __typename?: 'AccountSetDefaultAddress'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** An updated user instance. */ user?: Maybe; }; -/** - * Event sent when setting a new password is requested. - * - * Added in Saleor 3.15. - */ +/** Event sent when setting a new password is requested. */ export type AccountSetPasswordRequested = Event & { __typename?: 'AccountSetPasswordRequested'; /** The channel data. */ @@ -487,7 +471,7 @@ export type AccountSetPasswordRequested = Event & { */ export type AccountUpdate = { __typename?: 'AccountUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; user?: Maybe; @@ -516,49 +500,29 @@ export type Address = Node & ObjectWithMetadata & { isDefaultShippingAddress?: Maybe; /** The family name of the address. */ lastName: Scalars['String']['output']; - /** - * List of public metadata items. Can be accessed without permissions. - * - * Added in Saleor 3.10. - */ + /** List of public metadata items. Can be accessed without permissions. */ metadata: Array; /** * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.10. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.10. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** The phone number assigned the address. */ phone?: Maybe; /** The postal code of the address. */ postalCode: Scalars['String']['output']; - /** - * List of private metadata items. Requires staff permissions to access. - * - * Added in Saleor 3.10. - */ + /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; /** * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.10. */ 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. - * - * Added in Saleor 3.10. - */ + /** 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; /** The first line of the address. */ streetAddress1: Scalars['String']['output']; @@ -600,7 +564,7 @@ export type AddressPrivateMetafieldsArgs = { */ export type AddressCreate = { __typename?: 'AddressCreate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; address?: Maybe
; errors: Array; @@ -608,11 +572,7 @@ export type AddressCreate = { user?: Maybe; }; -/** - * Event sent when new address is created. - * - * Added in Saleor 3.5. - */ +/** Event sent when new address is created. */ export type AddressCreated = Event & { __typename?: 'AddressCreated'; /** The address the event relates to. */ @@ -637,7 +597,7 @@ export type AddressCreated = Event & { */ export type AddressDelete = { __typename?: 'AddressDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; address?: Maybe
; errors: Array; @@ -645,11 +605,7 @@ export type AddressDelete = { user?: Maybe; }; -/** - * Event sent when address is deleted. - * - * Added in Saleor 3.5. - */ +/** Event sent when address is deleted. */ export type AddressDeleted = Event & { __typename?: 'AddressDeleted'; /** The address the event relates to. */ @@ -664,6 +620,12 @@ export type AddressDeleted = Event & { version?: Maybe; }; +/** Filtering options for addresses. */ +export type AddressFilterInput = { + country?: InputMaybe; + phoneNumber?: InputMaybe; +}; + export type AddressInput = { /** City. */ city?: InputMaybe; @@ -680,9 +642,9 @@ export type AddressInput = { /** Family name. */ lastName?: InputMaybe; /** - * Address public metadata. + * Address public metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.15. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** @@ -717,14 +679,13 @@ export type AddressInput = { */ export type AddressSetDefault = { __typename?: 'AddressSetDefault'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** An updated user instance. */ user?: Maybe; }; -/** An enumeration. */ export type AddressTypeEnum = | 'BILLING' | 'SHIPPING'; @@ -739,7 +700,7 @@ export type AddressTypeEnum = */ export type AddressUpdate = { __typename?: 'AddressUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; address?: Maybe
; errors: Array; @@ -747,11 +708,7 @@ export type AddressUpdate = { user?: Maybe; }; -/** - * Event sent when address is updated. - * - * Added in Saleor 3.5. - */ +/** Event sent when address is updated. */ export type AddressUpdated = Event & { __typename?: 'AddressUpdated'; /** The address the event relates to. */ @@ -875,41 +832,37 @@ export type App = Node & ObjectWithMetadata & { accessToken?: Maybe; /** URL to iframe with the app. */ appUrl?: Maybe; + /** The App's author name. */ + author?: Maybe; + /** App's brand data. */ + brand?: Maybe; /** - * The App's author name. + * Circuit breaker last state change date. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Added in Saleor 3.21. */ - author?: Maybe; + breakerLastStateChange?: Maybe; /** - * App's brand data. - * - * Added in Saleor 3.14. + * Circuit breaker state, if open, sync webhooks operation is disrupted. * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Added in Saleor 3.21. */ - brand?: Maybe; + breakerState: CircuitBreakerStateEnum; /** * URL to iframe with the configuration for the app. - * @deprecated This field will be removed in Saleor 4.0. Use `appUrl` instead. + * @deprecated Use `appUrl` instead. */ configurationUrl?: Maybe; /** The date and time when the app was created. */ created?: Maybe; /** * Description of the data privacy defined for this app. - * @deprecated This field will be removed in Saleor 4.0. Use `dataPrivacyUrl` instead. + * @deprecated Use `dataPrivacyUrl` instead. */ dataPrivacy?: Maybe; /** URL to details about the privacy policy on the app owner page. */ dataPrivacyUrl?: Maybe; - /** - * App's dashboard extensions. - * - * Added in Saleor 3.1. - */ + /** App's dashboard extensions. */ extensions: Array; /** Homepage of the app. */ homepageUrl?: Maybe; @@ -923,11 +876,7 @@ export type App = Node & ObjectWithMetadata & { identifier?: Maybe; /** Determine if app will be set active or not. */ isActive?: Maybe; - /** - * URL to manifest used during app's installation. - * - * Added in Saleor 3.5. - */ + /** URL to manifest used during app's installation. */ manifestUrl?: Maybe; /** List of public metadata items. Can be accessed without permissions. */ metadata: Array; @@ -935,15 +884,9 @@ export type App = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Name of the app. */ name?: Maybe; @@ -955,15 +898,9 @@ export type App = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** Support page for the app. */ supportUrl?: Maybe; @@ -1020,57 +957,27 @@ export type AppPrivateMetafieldsArgs = { export type AppActivate = { __typename?: 'AppActivate'; app?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; errors: Array; }; -/** - * Represents the app's brand data. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the app's brand data. */ export type AppBrand = { __typename?: 'AppBrand'; - /** - * App's logos details. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** App's logos details. */ logo: AppBrandLogo; }; -/** - * Represents the app's brand logo data. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the app's brand logo data. */ export type AppBrandLogo = { __typename?: 'AppBrandLogo'; - /** - * URL to the default logo image. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** URL to the default logo image. */ default: Scalars['String']['output']; }; -/** - * Represents the app's brand logo data. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the app's brand logo data. */ export type AppBrandLogoDefaultArgs = { format?: InputMaybe; size?: InputMaybe; @@ -1102,7 +1009,7 @@ export type AppCountableEdge = { export type AppCreate = { __typename?: 'AppCreate'; app?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; /** The newly created authentication token. */ authToken?: Maybe; @@ -1120,7 +1027,7 @@ export type AppCreate = { export type AppDeactivate = { __typename?: 'AppDeactivate'; app?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; errors: Array; }; @@ -1136,29 +1043,25 @@ export type AppDeactivate = { export type AppDelete = { __typename?: 'AppDelete'; app?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; errors: Array; }; /** - * Delete failed installation. + * Deletes failed installation. * * Requires one of the following permissions: MANAGE_APPS. */ export type AppDeleteFailedInstallation = { __typename?: 'AppDeleteFailedInstallation'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; appInstallation?: Maybe; errors: Array; }; -/** - * Event sent when app is deleted. - * - * Added in Saleor 3.4. - */ +/** Event sent when app is deleted. */ export type AppDeleted = Event & { __typename?: 'AppDeleted'; /** The application the event relates to. */ @@ -1185,7 +1088,6 @@ export type AppError = { permissions?: Maybe>; }; -/** An enumeration. */ export type AppErrorCode = | 'FORBIDDEN' | 'GRAPHQL_ERROR' @@ -1214,12 +1116,43 @@ export type AppExtension = Node & { id: Scalars['ID']['output']; /** Label of the extension to show in the dashboard. */ label: Scalars['String']['output']; - /** Place where given extension will be mounted. */ + /** + * Place where given extension will be mounted. + * @deprecated Use `mountName` instead. + */ mount: AppExtensionMountEnum; + /** + * Name of the extension mount point in the dashboard. Replaces `mount` + * + * Added in Saleor 3.22. + */ + mountName: Scalars['String']['output']; + /** + * App extension options. + * + * Added in Saleor 3.22. + * @deprecated Use `settings` field instead. + */ + options?: Maybe; /** List of the app extension's permissions. */ permissions: Array; - /** Type of way how app extension will be opened. */ + /** + * App extension settings. Replaces `options` field. + * + * Added in Saleor 3.22. + */ + settings: Scalars['JSON']['output']; + /** + * Type of way how app extension will be opened. + * @deprecated Use `targetName` instead. + */ target: AppExtensionTargetEnum; + /** + * Name of the extension target in the dashboard. Replaces `target` + * + * Added in Saleor 3.22. + */ + targetName: Scalars['String']['output']; /** URL of a view where extension's iframe is placed. */ url: Scalars['String']['output']; }; @@ -1242,15 +1175,57 @@ export type AppExtensionCountableEdge = { }; export type AppExtensionFilterInput = { + /** + * DEPRECATED: Use `mountName` instead. + * @deprecated Field no longer supported + */ mount?: InputMaybe>; + /** + * Plain-text mount name (case insensitive) + * + * Added in Saleor 3.22. + */ + mountName?: InputMaybe>; + /** + * DEPRECATED: Use `targetName` instead. + * @deprecated Field no longer supported + */ target?: InputMaybe; + /** + * Plain-text target name (case insensitive) + * + * Added in Saleor 3.22. + */ + targetName?: InputMaybe; }; /** All places where app extension can be mounted. */ export type AppExtensionMountEnum = + | 'CATEGORY_DETAILS_MORE_ACTIONS' + | 'CATEGORY_OVERVIEW_CREATE' + | 'CATEGORY_OVERVIEW_MORE_ACTIONS' + | 'COLLECTION_DETAILS_MORE_ACTIONS' + | 'COLLECTION_DETAILS_WIDGETS' + | 'COLLECTION_OVERVIEW_CREATE' + | 'COLLECTION_OVERVIEW_MORE_ACTIONS' | 'CUSTOMER_DETAILS_MORE_ACTIONS' + | 'CUSTOMER_DETAILS_WIDGETS' | 'CUSTOMER_OVERVIEW_CREATE' | 'CUSTOMER_OVERVIEW_MORE_ACTIONS' + | 'DISCOUNT_DETAILS_MORE_ACTIONS' + | 'DISCOUNT_OVERVIEW_CREATE' + | 'DISCOUNT_OVERVIEW_MORE_ACTIONS' + | 'DRAFT_ORDER_DETAILS_MORE_ACTIONS' + | 'DRAFT_ORDER_DETAILS_WIDGETS' + | 'DRAFT_ORDER_OVERVIEW_CREATE' + | 'DRAFT_ORDER_OVERVIEW_MORE_ACTIONS' + | 'GIFT_CARD_DETAILS_MORE_ACTIONS' + | 'GIFT_CARD_DETAILS_WIDGETS' + | 'GIFT_CARD_OVERVIEW_CREATE' + | 'GIFT_CARD_OVERVIEW_MORE_ACTIONS' + | 'MENU_DETAILS_MORE_ACTIONS' + | 'MENU_OVERVIEW_CREATE' + | 'MENU_OVERVIEW_MORE_ACTIONS' | 'NAVIGATION_CATALOG' | 'NAVIGATION_CUSTOMERS' | 'NAVIGATION_DISCOUNTS' @@ -1258,11 +1233,46 @@ export type AppExtensionMountEnum = | 'NAVIGATION_PAGES' | 'NAVIGATION_TRANSLATIONS' | 'ORDER_DETAILS_MORE_ACTIONS' + | 'ORDER_DETAILS_WIDGETS' | 'ORDER_OVERVIEW_CREATE' | 'ORDER_OVERVIEW_MORE_ACTIONS' + | 'PAGE_DETAILS_MORE_ACTIONS' + | 'PAGE_OVERVIEW_CREATE' + | 'PAGE_OVERVIEW_MORE_ACTIONS' + | 'PAGE_TYPE_DETAILS_MORE_ACTIONS' + | 'PAGE_TYPE_OVERVIEW_CREATE' + | 'PAGE_TYPE_OVERVIEW_MORE_ACTIONS' | 'PRODUCT_DETAILS_MORE_ACTIONS' + | 'PRODUCT_DETAILS_WIDGETS' | 'PRODUCT_OVERVIEW_CREATE' - | 'PRODUCT_OVERVIEW_MORE_ACTIONS'; + | 'PRODUCT_OVERVIEW_MORE_ACTIONS' + | 'TRANSLATIONS_MORE_ACTIONS' + | 'VOUCHER_DETAILS_MORE_ACTIONS' + | 'VOUCHER_DETAILS_WIDGETS' + | 'VOUCHER_OVERVIEW_CREATE' + | 'VOUCHER_OVERVIEW_MORE_ACTIONS'; + +/** Represents the options for an app extension. */ +export type AppExtensionOptionsNewTab = { + __typename?: 'AppExtensionOptionsNewTab'; + /** + * Options controlling behavior of the NEW_TAB extension target + * @deprecated Use `settings` field directly. + */ + newTabTarget?: Maybe; +}; + +/** Represents the options for an app extension. */ +export type AppExtensionOptionsWidget = { + __typename?: 'AppExtensionOptionsWidget'; + /** + * Options for displaying a Widget + * @deprecated Use `settings` field directly. + */ + widgetTarget?: Maybe; +}; + +export type AppExtensionPossibleOptions = AppExtensionOptionsNewTab | AppExtensionOptionsWidget; /** * All available ways of opening an app extension. @@ -1272,7 +1282,9 @@ export type AppExtensionMountEnum = */ export type AppExtensionTargetEnum = | 'APP_PAGE' - | 'POPUP'; + | 'NEW_TAB' + | 'POPUP' + | 'WIDGET'; /** * Fetch and validate manifest. @@ -1281,7 +1293,7 @@ export type AppExtensionTargetEnum = */ export type AppFetchManifest = { __typename?: 'AppFetchManifest'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; errors: Array; /** The validated manifest. */ @@ -1310,7 +1322,7 @@ export type AppInput = { /** Install new app by using app manifest. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS. */ export type AppInstall = { __typename?: 'AppInstall'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; appInstallation?: Maybe; errors: Array; @@ -1332,13 +1344,7 @@ export type AppInstallation = Job & Node & { __typename?: 'AppInstallation'; /** The name of the app installation. */ appName: Scalars['String']['output']; - /** - * App's brand data. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** App's brand data. */ brand?: Maybe; /** Created date time of job in ISO 8601 format. */ createdAt: Scalars['DateTime']['output']; @@ -1354,11 +1360,7 @@ export type AppInstallation = Job & Node & { updatedAt: Scalars['DateTime']['output']; }; -/** - * Event sent when new app is installed. - * - * Added in Saleor 3.4. - */ +/** Event sent when new app is installed. */ export type AppInstalled = Event & { __typename?: 'AppInstalled'; /** The application the event relates to. */ @@ -1373,52 +1375,22 @@ export type AppInstalled = Event & { version?: Maybe; }; -/** - * Represents the app's manifest brand data. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the app's manifest brand data. */ export type AppManifestBrand = { __typename?: 'AppManifestBrand'; - /** - * App's logos details. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** App's logos details. */ logo: AppManifestBrandLogo; }; -/** - * Represents the app's manifest brand data. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the app's manifest brand data. */ export type AppManifestBrandLogo = { __typename?: 'AppManifestBrandLogo'; - /** - * Data URL with a base64 encoded logo image. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Data URL with a base64 encoded logo image. */ default: Scalars['String']['output']; }; -/** - * Represents the app's manifest brand data. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the app's manifest brand data. */ export type AppManifestBrandLogoDefaultArgs = { format?: InputMaybe; size?: InputMaybe; @@ -1428,33 +1400,45 @@ export type AppManifestExtension = { __typename?: 'AppManifestExtension'; /** Label of the extension to show in the dashboard. */ label: Scalars['String']['output']; - /** Place where given extension will be mounted. */ + /** + * Place where given extension will be mounted. + * @deprecated Use `mountName` instead. + */ mount: AppExtensionMountEnum; + /** + * Name of the extension mount point in the dashboard. Replaces `mount` + * + * Added in Saleor 3.22. + */ + mountName: Scalars['String']['output']; /** List of the app extension's permissions. */ permissions: Array; - /** Type of way how app extension will be opened. */ + /** + * JSON object with settings for this extension. + * + * Added in Saleor 3.22. + */ + settings: Scalars['JSON']['output']; + /** + * Type of way how app extension will be opened. + * @deprecated Use `targetName` instead. + */ target: AppExtensionTargetEnum; + /** + * Name of the extension target in the dashboard. Replaces `target` + * + * Added in Saleor 3.22. + */ + targetName: Scalars['String']['output']; /** URL of a view where extension's iframe is placed. */ url: Scalars['String']['output']; }; export type AppManifestRequiredSaleorVersion = { __typename?: 'AppManifestRequiredSaleorVersion'; - /** - * Required Saleor version as semver range. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Required Saleor version as semver range. */ constraint: Scalars['String']['output']; - /** - * Informs if the Saleor version matches the required one. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Informs if the Saleor version matches the required one. */ satisfied: Scalars['Boolean']['output']; }; @@ -1472,6 +1456,22 @@ export type AppManifestWebhook = { targetUrl: Scalars['String']['output']; }; +/** + * 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. + * + * Requires one of the following permissions: MANAGE_APPS. + */ +export type AppReenableSyncWebhooks = { + __typename?: 'AppReenableSyncWebhooks'; + /** App for which sync webhooks were re-enabled. */ + app?: Maybe; + /** @deprecated Use `errors` field instead. */ + appErrors: Array; + errors: Array; +}; + /** * Retry failed installation of new app. * @@ -1482,7 +1482,7 @@ export type AppManifestWebhook = { */ export type AppRetryInstall = { __typename?: 'AppRetryInstall'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; appInstallation?: Maybe; errors: Array; @@ -1501,11 +1501,7 @@ export type AppSortingInput = { field: AppSortField; }; -/** - * Event sent when app status has changed. - * - * Added in Saleor 3.4. - */ +/** Event sent when app status has changed. */ export type AppStatusChanged = Event & { __typename?: 'AppStatusChanged'; /** The application the event relates to. */ @@ -1538,7 +1534,7 @@ export type AppToken = Node & { */ export type AppTokenCreate = { __typename?: 'AppTokenCreate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; appToken?: Maybe; /** The newly created authentication token. */ @@ -1553,7 +1549,7 @@ export type AppTokenCreate = { */ export type AppTokenDelete = { __typename?: 'AppTokenDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; appToken?: Maybe; errors: Array; @@ -1569,7 +1565,7 @@ export type AppTokenInput = { /** Verify provided app token. */ export type AppTokenVerify = { __typename?: 'AppTokenVerify'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; errors: Array; /** Determine if token is valid or not. */ @@ -1594,16 +1590,12 @@ export type AppTypeEnum = export type AppUpdate = { __typename?: 'AppUpdate'; app?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ appErrors: Array; errors: Array; }; -/** - * Event sent when app is updated. - * - * Added in Saleor 3.4. - */ +/** Event sent when app is updated. */ export type AppUpdated = Event & { __typename?: 'AppUpdated'; /** The application the event relates to. */ @@ -1618,7 +1610,6 @@ export type AppUpdated = Event & { version?: Maybe; }; -/** An enumeration. */ export type AreaUnitsEnum = | 'SQ_CM' | 'SQ_DM' @@ -1639,67 +1630,488 @@ export type AssignNavigation = { errors: Array; /** Assigned navigation menu. */ menu?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; }; /** - * Represents assigned attribute to variant with variant selection attached. + * Represents an attribute assigned to an object. * - * Added in Saleor 3.1. + * Added in Saleor 3.22. */ -export type AssignedVariantAttribute = { - __typename?: 'AssignedVariantAttribute'; - /** Attribute assigned to variant. */ +export type AssignedAttribute = { + /** Attribute assigned to an object. */ attribute: Attribute; - /** Determines, whether assigned attribute is allowed for variant selection. Supported variant types for variant selection are: ['dropdown', 'boolean', 'swatch', 'numeric'] */ - variantSelection: Scalars['Boolean']['output']; }; -/** Custom attribute of a product. Attributes can be assigned to products and variants at the product type level. */ -export type Attribute = Node & ObjectWithMetadata & { - __typename?: 'Attribute'; - /** - * 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. - * @deprecated This field will be removed in Saleor 4.0. - */ - availableInGrid: Scalars['Boolean']['output']; - /** List of attribute's values. */ - choices?: Maybe; - /** The entity type which can be used as a reference. */ - entityType?: Maybe; - /** - * External ID of this attribute. - * - * Added in Saleor 3.10. - */ - externalReference?: Maybe; - /** Whether the attribute can be filtered in dashboard. Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES, MANAGE_PRODUCTS, MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. */ - filterableInDashboard: Scalars['Boolean']['output']; - /** - * 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. - * @deprecated This field will be removed in Saleor 4.0. - */ - filterableInStorefront: Scalars['Boolean']['output']; - /** The ID of the attribute. */ - id: Scalars['ID']['output']; - /** The input type to use for entering attribute values in the dashboard. */ - inputType?: Maybe; - /** List of public metadata items. Can be accessed without permissions. */ - metadata: Array; - /** - * A single key from public metadata. - * - * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. - */ - metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. +export type AssignedAttributeReferenceInput = { + /** Returns objects with a reference pointing to a category identified by the given slug. */ + categorySlugs?: InputMaybe; + /** Returns objects with a reference pointing to a collection identified by the given slug. */ + collectionSlugs?: InputMaybe; + /** Returns objects with a reference pointing to a page identified by the given slug. */ + pageSlugs?: InputMaybe; + /** Returns objects with a reference pointing to a product identified by the given slug. */ + productSlugs?: InputMaybe; + /** Returns objects with a reference pointing to a product variant identified by the given sku. */ + productVariantSkus?: InputMaybe; + /** Returns objects with a reference pointing to an object identified by the given ID. */ + referencedIds?: InputMaybe; +}; + +export type AssignedAttributeValueInput = { + /** Filter by boolean value for attributes of boolean type. */ + boolean?: InputMaybe; + /** Filter by date value for attributes of date type. */ + date?: InputMaybe; + /** Filter by date time value for attributes of date time type. */ + dateTime?: InputMaybe; + /** Filter by name assigned to AttributeValue. */ + name?: InputMaybe; + /** Filter by numeric value for attributes of numeric type. */ + numeric?: InputMaybe; + /** Filter by reference attribute value. */ + reference?: InputMaybe; + /** Filter by slug assigned to AttributeValue. */ + slug?: InputMaybe; +}; + +export type AssignedAttributeWhereInput = { + /** Filter by attribute slug. */ + 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. */ + value?: InputMaybe; +}; + +/** + * Represents a boolean attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedBooleanAttribute = AssignedAttribute & { + __typename?: 'AssignedBooleanAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned boolean value. */ + value?: Maybe; +}; + +/** + * Represents a single choice value of the attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedChoiceAttributeValue = { + __typename?: 'AssignedChoiceAttributeValue'; + /** Name of a value displayed in the interface. */ + name?: Maybe; + /** Internal representation of a value (unique per attribute). */ + slug?: Maybe; + /** Translation of the name. */ + translation?: Maybe; +}; + + +/** + * Represents a single choice value of the attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedChoiceAttributeValueTranslationArgs = { + languageCode: LanguageCodeEnum; +}; + +/** + * Represents a date attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedDateAttribute = AssignedAttribute & { + __typename?: 'AssignedDateAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned date value. */ + value?: Maybe; +}; + +/** + * Represents a date time attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedDateTimeAttribute = AssignedAttribute & { + __typename?: 'AssignedDateTimeAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned date time value. */ + value?: Maybe; +}; + +/** + * Represents file attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedFileAttribute = AssignedAttribute & { + __typename?: 'AssignedFileAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned file. */ + value?: Maybe; +}; + +/** + * Represents multi category reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiCategoryReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedMultiCategoryReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** List of assigned category references. */ + value: Array; +}; + + +/** + * Represents multi category reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiCategoryReferenceAttributeValueArgs = { + limit?: InputMaybe; +}; + +/** + * Represents a multi choice attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiChoiceAttribute = AssignedAttribute & { + __typename?: 'AssignedMultiChoiceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** List of assigned choice values. */ + value: Array; +}; + + +/** + * Represents a multi choice attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiChoiceAttributeValueArgs = { + limit?: InputMaybe; +}; + +/** + * Represents multi collection reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiCollectionReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedMultiCollectionReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** List of assigned collection references. */ + value: Array; +}; + + +/** + * Represents multi collection reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiCollectionReferenceAttributeValueArgs = { + limit?: InputMaybe; +}; + +/** + * Represents multi page reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiPageReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedMultiPageReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** List of assigned page references. */ + value: Array; +}; + + +/** + * Represents multi page reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiPageReferenceAttributeValueArgs = { + limit?: InputMaybe; +}; + +/** + * Represents multi product reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiProductReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedMultiProductReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** List of assigned product references. */ + value: Array; +}; + + +/** + * Represents multi product reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiProductReferenceAttributeValueArgs = { + limit?: InputMaybe; +}; + +/** + * Represents multi product variant reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiProductVariantReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedMultiProductVariantReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** List of assigned product variant references. */ + value: Array; +}; + + +/** + * Represents multi product variant reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedMultiProductVariantReferenceAttributeValueArgs = { + limit?: InputMaybe; +}; + +/** + * Represents a numeric value of an attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedNumericAttribute = AssignedAttribute & { + __typename?: 'AssignedNumericAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned numeric value. */ + value?: Maybe; +}; + +/** + * Represents plain text attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedPlainTextAttribute = AssignedAttribute & { + __typename?: 'AssignedPlainTextAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** Translation of the plain text content in the specified language. */ + translation?: Maybe; + /** The assigned plain text content. */ + value?: Maybe; +}; + + +/** + * Represents plain text attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedPlainTextAttributeTranslationArgs = { + languageCode: LanguageCodeEnum; +}; + +/** + * Represents single category reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedSingleCategoryReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedSingleCategoryReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned category reference. */ + value?: Maybe; +}; + +/** + * Represents a single choice attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedSingleChoiceAttribute = AssignedAttribute & { + __typename?: 'AssignedSingleChoiceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned choice value. */ + value?: Maybe; +}; + +/** + * Represents single collection reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedSingleCollectionReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedSingleCollectionReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned collection reference. */ + value?: Maybe; +}; + +/** + * Represents single page reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedSinglePageReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedSinglePageReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned page reference. */ + value?: Maybe; +}; + +/** + * Represents single product reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedSingleProductReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedSingleProductReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned product reference. */ + value?: Maybe; +}; + +/** + * Represents single product variant reference attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedSingleProductVariantReferenceAttribute = AssignedAttribute & { + __typename?: 'AssignedSingleProductVariantReferenceAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned product variant reference. */ + value?: Maybe; +}; + +/** + * Represents a swatch attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedSwatchAttribute = AssignedAttribute & { + __typename?: 'AssignedSwatchAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** The assigned swatch value. */ + value?: Maybe; +}; + +/** + * Represents a single swatch value. + * + * Added in Saleor 3.22. + */ +export type AssignedSwatchAttributeValue = { + __typename?: 'AssignedSwatchAttributeValue'; + /** File associated with the attribute. */ + file?: Maybe; + /** Hex color code. */ + hexColor?: Maybe; + /** Name of the selected swatch value. */ + name?: Maybe; + /** Slug of the selected swatch value. */ + slug?: Maybe; +}; + +/** + * Represents text attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedTextAttribute = AssignedAttribute & { + __typename?: 'AssignedTextAttribute'; + /** Attribute assigned to an object. */ + attribute: Attribute; + /** Translation of the rich text content in the specified language. */ + translation?: Maybe; + /** The assigned rich text content. */ + value?: Maybe; +}; + + +/** + * Represents text attribute. + * + * Added in Saleor 3.22. + */ +export type AssignedTextAttributeTranslationArgs = { + languageCode: LanguageCodeEnum; +}; + +/** Represents assigned attribute to variant with variant selection attached. */ +export type AssignedVariantAttribute = { + __typename?: 'AssignedVariantAttribute'; + /** Attribute assigned to variant. */ + attribute: Attribute; + /** Determines, whether assigned attribute is allowed for variant selection. Supported variant types for variant selection are: ['dropdown', 'boolean', 'swatch', 'numeric'] */ + variantSelection: Scalars['Boolean']['output']; +}; + +/** Custom attribute of a product. Attributes can be assigned to products and variants at the product type level. */ +export type Attribute = Node & ObjectWithMetadata & { + __typename?: 'Attribute'; + /** + * 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. + * @deprecated Field no longer supported */ + availableInGrid: Scalars['Boolean']['output']; + /** A list of predefined attribute choices available for selection. Available only for attributes with predefined choices. */ + choices?: Maybe; + /** The entity type which can be used as a reference. */ + entityType?: Maybe; + /** External ID of this attribute. */ + externalReference?: Maybe; + /** Whether the attribute can be filtered in dashboard. Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES, MANAGE_PRODUCTS, MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. */ + filterableInDashboard: Scalars['Boolean']['output']; + /** + * 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. + * @deprecated Field no longer supported + */ + filterableInStorefront: Scalars['Boolean']['output']; + /** The ID of the attribute. */ + id: Scalars['ID']['output']; + /** The input type to use for entering attribute values in the dashboard. */ + inputType?: Maybe; + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array; + /** + * A single key from public metadata. + * + * Tip: Use GraphQL aliases to fetch multiple keys. + */ + metafield?: Maybe; + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Name of an attribute displayed in the interface. */ name?: Maybe; @@ -1709,25 +2121,25 @@ export type Attribute = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** A list of product types that use this attribute as a product attribute. */ productTypes: ProductTypeCountableConnection; /** A list of product types that use this attribute as a product variant attribute. */ productVariantTypes: ProductTypeCountableConnection; + /** + * The reference types (product or page type) that are used to narrow down the choices of reference objects. + * + * Added in Saleor 3.22. + */ + referenceTypes?: Maybe>; /** Internal representation of an attribute name. */ slug?: Maybe; /** * 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. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ storefrontSearchPosition: Scalars['Int']['output']; /** Returns translated attribute fields for the given language code. */ @@ -1752,7 +2164,9 @@ export type AttributeChoicesArgs = { filter?: InputMaybe; first?: InputMaybe; last?: InputMaybe; + search?: InputMaybe; sortBy?: InputMaybe; + where?: InputMaybe; }; @@ -1798,6 +2212,12 @@ export type AttributeProductVariantTypesArgs = { }; +/** Custom attribute of a product. Attributes can be assigned to products and variants at the product type level. */ +export type AttributeReferenceTypesArgs = { + limit?: InputMaybe; +}; + + /** Custom attribute of a product. Attributes can be assigned to products and variants at the product type level. */ export type AttributeTranslationArgs = { languageCode: LanguageCodeEnum; @@ -1806,10 +2226,6 @@ export type AttributeTranslationArgs = { /** * Creates attributes. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Triggers the following webhook events: * - ATTRIBUTE_CREATED (async): An attribute was created. */ @@ -1832,7 +2248,6 @@ export type AttributeBulkCreateError = { path?: Maybe; }; -/** An enumeration. */ export type AttributeBulkCreateErrorCode = | 'ALREADY_EXISTS' | 'BLANK' @@ -1862,7 +2277,7 @@ export type AttributeBulkCreateResult = { */ export type AttributeBulkDelete = { __typename?: 'AttributeBulkDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ attributeErrors: Array; /** Returns how many objects were affected. */ count: Scalars['Int']['output']; @@ -1872,10 +2287,6 @@ export type AttributeBulkDelete = { /** * Creates/updates translations for attributes. * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. */ export type AttributeBulkTranslate = { @@ -1919,10 +2330,6 @@ export type AttributeBulkTranslateResult = { /** * Updates attributes. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Triggers the following webhook events: * - ATTRIBUTE_UPDATED (async): An attribute was updated. Optionally called when new attribute value was created or deleted. * - ATTRIBUTE_VALUE_CREATED (async): Called optionally when an attribute value was created. @@ -1947,7 +2354,6 @@ export type AttributeBulkUpdateError = { path?: Maybe; }; -/** An enumeration. */ export type AttributeBulkUpdateErrorCode = | 'ALREADY_EXISTS' | 'BLANK' @@ -2014,8 +2420,9 @@ export type AttributeCountableEdge = { */ export type AttributeCreate = { __typename?: 'AttributeCreate'; + /** The created attribute. */ attribute?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ attributeErrors: Array; errors: Array; }; @@ -2028,24 +2435,18 @@ export type AttributeCreate = { export type AttributeCreateInput = { /** * Whether the attribute can be displayed in the admin product list. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ availableInGrid?: InputMaybe; /** The entity type which can be used as a reference. */ entityType?: InputMaybe; - /** - * External ID of this attribute. - * - * Added in Saleor 3.10. - */ + /** External ID of this attribute. */ externalReference?: InputMaybe; /** Whether the attribute can be filtered in dashboard. */ filterableInDashboard?: InputMaybe; /** * Whether the attribute can be filtered in storefront. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ filterableInStorefront?: InputMaybe; /** The input type to use for entering attribute values in the dashboard. */ @@ -2054,12 +2455,19 @@ export type AttributeCreateInput = { isVariantOnly?: InputMaybe; /** Name of an attribute displayed in the interface. */ name: Scalars['String']['input']; + /** + * Specifies reference types to narrow down the choices of reference objects. Applicable only for `REFERENCE` and `SINGLE_REFERENCE` attributes with `PRODUCT`, `PRODUCT_VARIANT` and `PAGE` entity types. Accepts `ProductType` IDs for `PRODUCT` and `PRODUCT_VARIANT` entity types, and `PageType` IDs for `PAGE` entity type. If omitted, all objects of the selected entity type are available as attribute values. + * + * A maximum of 100 reference types can be specified. + * + * Added in Saleor 3.22. + */ + referenceTypes?: InputMaybe>; /** Internal representation of an attribute name. */ slug?: InputMaybe; /** * The position of the attribute in the storefront navigation (0 by default). - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ storefrontSearchPosition?: InputMaybe; /** The attribute type. */ @@ -2074,11 +2482,7 @@ export type AttributeCreateInput = { visibleInStorefront?: InputMaybe; }; -/** - * Event sent when new attribute is created. - * - * Added in Saleor 3.5. - */ +/** Event sent when new attribute is created. */ export type AttributeCreated = Event & { __typename?: 'AttributeCreated'; /** The attribute the event relates to. */ @@ -2104,16 +2508,12 @@ export type AttributeCreated = Event & { export type AttributeDelete = { __typename?: 'AttributeDelete'; attribute?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ attributeErrors: Array; errors: Array; }; -/** - * Event sent when attribute is deleted. - * - * Added in Saleor 3.5. - */ +/** Event sent when attribute is deleted. */ export type AttributeDeleted = Event & { __typename?: 'AttributeDeleted'; /** The attribute the event relates to. */ @@ -2128,8 +2528,9 @@ export type AttributeDeleted = Event & { version?: Maybe; }; -/** An enumeration. */ export type AttributeEntityTypeEnum = + | 'CATEGORY' + | 'COLLECTION' | 'PAGE' | 'PRODUCT' | 'PRODUCT_VARIANT'; @@ -2151,7 +2552,6 @@ export type AttributeError = { message?: Maybe; }; -/** An enumeration. */ export type AttributeErrorCode = | 'ALREADY_EXISTS' | 'GRAPHQL_ERROR' @@ -2164,8 +2564,7 @@ export type AttributeFilterInput = { availableInGrid?: InputMaybe; /** * Specifies the channel by which the data should be filtered. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. + * @deprecated Use root-level channel argument instead. */ channel?: InputMaybe; filterableInDashboard?: InputMaybe; @@ -2183,21 +2582,37 @@ export type AttributeFilterInput = { }; export type AttributeInput = { - /** The boolean value of the attribute. */ + /** + * The boolean value of the attribute. Requires `slug` to be provided. + * @deprecated 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. */ + /** + * 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. + */ date?: InputMaybe; - /** The date/time range that the returned values should be in. */ + /** + * The date/time range that the returned values should be in. Requires `slug` to be provided. + * @deprecated Use `value` instead. + */ dateTime?: InputMaybe; /** Internal representation of an attribute name. */ - slug: Scalars['String']['input']; - /** Internal representation of a value (unique per attribute). */ + 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`. */ + 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. + */ values?: InputMaybe>; - /** The range that the returned values should be in. */ + /** + * The range that the returned values should be in. Requires `slug` to be provided. + * @deprecated Use `value` instead. + */ valuesRange?: InputMaybe; }; -/** An enumeration. */ export type AttributeInputTypeEnum = | 'BOOLEAN' | 'DATE' @@ -2209,6 +2624,7 @@ export type AttributeInputTypeEnum = | 'PLAIN_TEXT' | 'REFERENCE' | 'RICH_TEXT' + | 'SINGLE_REFERENCE' | 'SWATCH'; export type AttributeInputTypeEnumFilterInput = { @@ -2231,7 +2647,7 @@ export type AttributeReorderValues = { __typename?: 'AttributeReorderValues'; /** Attribute from which values are reordered. */ attribute?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ attributeErrors: Array; errors: Array; }; @@ -2268,14 +2684,10 @@ export type AttributeTranslatableContent = Node & { __typename?: 'AttributeTranslatableContent'; /** * Custom attribute of a product. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ attribute?: Maybe; - /** - * The ID of the attribute to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the attribute to translate. */ attributeId: Scalars['ID']['output']; /** The ID of the attribute translatable content. */ id: Scalars['ID']['output']; @@ -2300,11 +2712,10 @@ export type AttributeTranslate = { __typename?: 'AttributeTranslate'; attribute?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; -/** An enumeration. */ export type AttributeTranslateErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' @@ -2320,15 +2731,10 @@ export type AttributeTranslation = Node & { language: LanguageDisplay; /** Translated attribute name. */ name: Scalars['String']['output']; - /** - * Represents the attribute fields to translate. - * - * Added in Saleor 3.14. - */ + /** Represents the attribute fields to translate. */ translatableContent?: Maybe; }; -/** An enumeration. */ export type AttributeTypeEnum = | 'PAGE_TYPE' | 'PRODUCT_TYPE'; @@ -2350,8 +2756,9 @@ export type AttributeTypeEnumFilterInput = { */ export type AttributeUpdate = { __typename?: 'AttributeUpdate'; + /** The updated attribute. */ attribute?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ attributeErrors: Array; errors: Array; }; @@ -2366,36 +2773,37 @@ export type AttributeUpdateInput = { addValues?: InputMaybe>; /** * Whether the attribute can be displayed in the admin product list. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ availableInGrid?: InputMaybe; - /** - * External ID of this product. - * - * Added in Saleor 3.10. - */ + /** External ID of this product. */ externalReference?: InputMaybe; /** Whether the attribute can be filtered in dashboard. */ filterableInDashboard?: InputMaybe; /** * Whether the attribute can be filtered in storefront. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ filterableInStorefront?: InputMaybe; /** Whether the attribute is for variants only. */ isVariantOnly?: InputMaybe; /** Name of an attribute displayed in the interface. */ name?: InputMaybe; + /** + * Specifies reference types to narrow down the choices of reference objects. Applicable only for `REFERENCE` and `SINGLE_REFERENCE` attributes with `PRODUCT`, `PRODUCT_VARIANT` and `PAGE` entity types. Accepts `ProductType` IDs for `PRODUCT` and `PRODUCT_VARIANT` entity types, and `PageType` IDs for `PAGE` entity type. If omitted, all objects of the selected entity type are available as attribute values. + * + * A maximum of 100 reference types can be specified. + * + * Added in Saleor 3.22. + */ + referenceTypes?: InputMaybe>; /** IDs of values to be removed from this attribute. */ removeValues?: InputMaybe>; /** Internal representation of an attribute name. */ slug?: InputMaybe; /** * The position of the attribute in the storefront navigation (0 by default). - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ storefrontSearchPosition?: InputMaybe; /** The unit of attribute values. */ @@ -2406,11 +2814,7 @@ export type AttributeUpdateInput = { visibleInStorefront?: InputMaybe; }; -/** - * Event sent when attribute is updated. - * - * Added in Saleor 3.5. - */ +/** Event sent when attribute is updated. */ export type AttributeUpdated = Event & { __typename?: 'AttributeUpdated'; /** The attribute the event relates to. */ @@ -2434,11 +2838,7 @@ export type AttributeValue = Node & { date?: Maybe; /** Represents the date/time value of the attribute value. */ dateTime?: Maybe; - /** - * External ID of this attribute value. - * - * Added in Saleor 3.10. - */ + /** External ID of this attribute value. */ externalReference?: Maybe; /** Represents file URL and content type (if attribute value is a file). */ file?: Maybe; @@ -2450,7 +2850,7 @@ export type AttributeValue = Node & { name?: Maybe; /** Represents the text of the attribute value, plain text without formatting. */ plainText?: Maybe; - /** The ID of the attribute reference. */ + /** The ID of the referenced object. */ reference?: Maybe; /** * Represents the text of the attribute value, includes formatting. @@ -2483,7 +2883,7 @@ export type AttributeValueTranslationArgs = { */ export type AttributeValueBulkDelete = { __typename?: 'AttributeValueBulkDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ attributeErrors: Array; /** Returns how many objects were affected. */ count: Scalars['Int']['output']; @@ -2491,11 +2891,7 @@ export type AttributeValueBulkDelete = { }; /** - * Creates/updates translations for attributes values. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Creates/updates translations for attribute values. * * Requires one of the following permissions: MANAGE_TRANSLATIONS. */ @@ -2567,7 +2963,7 @@ export type AttributeValueCreate = { __typename?: 'AttributeValueCreate'; /** The updated attribute. */ attribute?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ attributeErrors: Array; attributeValue?: Maybe; errors: Array; @@ -2576,11 +2972,7 @@ export type AttributeValueCreate = { export type AttributeValueCreateInput = { /** File content type. */ contentType?: InputMaybe; - /** - * External ID of this attribute value. - * - * Added in Saleor 3.10. - */ + /** External ID of this attribute value. */ externalReference?: InputMaybe; /** URL of the file attribute. Every time, a new value is created. */ fileUrl?: InputMaybe; @@ -2588,27 +2980,21 @@ export type AttributeValueCreateInput = { name: Scalars['String']['input']; /** * Represents the text of the attribute value, plain text without formatting. - * - * DEPRECATED: this field will be removed in Saleor 4.0.The plain text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute. + * @deprecated 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: this field will be removed in Saleor 4.0.The rich text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute. + * @deprecated 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). */ value?: InputMaybe; }; -/** - * Event sent when new attribute value is created. - * - * Added in Saleor 3.5. - */ +/** Event sent when new attribute value is created. */ export type AttributeValueCreated = Event & { __typename?: 'AttributeValueCreated'; /** The attribute value the event relates to. */ @@ -2636,17 +3022,13 @@ export type AttributeValueDelete = { __typename?: 'AttributeValueDelete'; /** The updated attribute. */ attribute?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ attributeErrors: Array; attributeValue?: Maybe; errors: Array; }; -/** - * Event sent when attribute value is deleted. - * - * Added in Saleor 3.5. - */ +/** Event sent when attribute value is deleted. */ export type AttributeValueDeleted = Event & { __typename?: 'AttributeValueDeleted'; /** The attribute value the event relates to. */ @@ -2676,47 +3058,36 @@ export type AttributeValueInput = { date?: InputMaybe; /** Represents the date/time value of the attribute value. */ dateTime?: InputMaybe; - /** - * Attribute value ID or external reference. - * - * Added in Saleor 3.9. - */ + /** Attribute value ID or external reference. */ dropdown?: InputMaybe; - /** - * External ID of this attribute. - * - * Added in Saleor 3.14. - */ + /** External ID of this attribute. */ externalReference?: InputMaybe; /** URL of the file attribute. Every time, a new value is created. */ file?: InputMaybe; /** ID of the selected attribute. */ id?: InputMaybe; - /** - * List of attribute value IDs or external references. - * - * Added in Saleor 3.9. - */ + /** List of attribute value IDs or external references. */ multiselect?: InputMaybe>; - /** - * Numeric value of an attribute. - * - * Added in Saleor 3.9. - */ + /** Numeric value of an attribute. */ numeric?: InputMaybe; /** Plain text content. */ plainText?: InputMaybe; + /** + * ID of the referenced entity for single reference attribute. + * + * Added in Saleor 3.22. + */ + reference?: InputMaybe; /** List of entity IDs that will be used as references. */ references?: InputMaybe>; /** Text content in JSON format. */ richText?: InputMaybe; + /** Attribute value ID or external reference. */ + swatch?: InputMaybe; /** - * Attribute value ID or external reference. - * - * Added in Saleor 3.9. + * 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 */ - swatch?: InputMaybe; - /** The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created. This field will be removed in Saleor 4.0. */ values?: InputMaybe>; }; @@ -2726,15 +3097,9 @@ export type AttributeValueInput = { * 2. If externalReference is provided, then attribute value will be resolved by external reference. * 3. If value is provided, then attribute value will be resolved by value. If this attribute value doesn't exist, then it will be created. * 4. If externalReference and value is provided then new attribute value will be created. - * - * Added in Saleor 3.9. */ export type AttributeValueSelectableTypeInput = { - /** - * External reference of an attribute value. - * - * Added in Saleor 3.14. - */ + /** External reference of an attribute value. */ externalReference?: InputMaybe; /** ID of an attribute value. */ id?: InputMaybe; @@ -2745,22 +3110,14 @@ export type AttributeValueSelectableTypeInput = { /** Represents attribute value's original translatable fields and related translations. */ export type AttributeValueTranslatableContent = Node & { __typename?: 'AttributeValueTranslatableContent'; - /** - * Associated attribute that can be translated. - * - * Added in Saleor 3.9. - */ + /** Associated attribute that can be translated. */ attribute?: Maybe; /** * Represents a value of an attribute. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ attributeValue?: Maybe; - /** - * The ID of the attribute value to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the attribute value to translate. */ attributeValueId: Scalars['ID']['output']; /** The ID of the attribute value translatable content. */ id: Scalars['ID']['output']; @@ -2793,11 +3150,10 @@ export type AttributeValueTranslate = { __typename?: 'AttributeValueTranslate'; attributeValue?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; -/** An enumeration. */ export type AttributeValueTranslateErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' @@ -2821,11 +3177,7 @@ export type AttributeValueTranslation = Node & { * Rich text format. For reference see https://editorjs.io/ */ richText?: Maybe; - /** - * Represents the attribute value fields to translate. - * - * Added in Saleor 3.14. - */ + /** Represents the attribute value fields to translate. */ translatableContent?: Maybe; }; @@ -2854,7 +3206,7 @@ export type AttributeValueUpdate = { __typename?: 'AttributeValueUpdate'; /** The updated attribute. */ attribute?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ attributeErrors: Array; attributeValue?: Maybe; errors: Array; @@ -2863,11 +3215,7 @@ export type AttributeValueUpdate = { export type AttributeValueUpdateInput = { /** File content type. */ contentType?: InputMaybe; - /** - * External ID of this attribute value. - * - * Added in Saleor 3.10. - */ + /** External ID of this attribute value. */ externalReference?: InputMaybe; /** URL of the file attribute. Every time, a new value is created. */ fileUrl?: InputMaybe; @@ -2875,27 +3223,21 @@ export type AttributeValueUpdateInput = { name?: InputMaybe; /** * Represents the text of the attribute value, plain text without formatting. - * - * DEPRECATED: this field will be removed in Saleor 4.0.The plain text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute. + * @deprecated 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: this field will be removed in Saleor 4.0.The rich text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute. + * @deprecated 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). */ value?: InputMaybe; }; -/** - * Event sent when attribute value is updated. - * - * Added in Saleor 3.5. - */ +/** Event sent when attribute value is updated. */ export type AttributeValueUpdated = Event & { __typename?: 'AttributeValueUpdated'; /** The attribute value the event relates to. */ @@ -2910,13 +3252,18 @@ export type AttributeValueUpdated = Event & { version?: Maybe; }; -/** - * Where filtering options. - * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Where filtering options for attribute values. */ +export type AttributeValueWhereInput = { + /** List of conditions that must be met. */ + AND?: InputMaybe>; + /** A list of conditions of which at least one must be met. */ + OR?: InputMaybe>; + ids?: InputMaybe>; + name?: InputMaybe; + slug?: InputMaybe; +}; + +/** Where filtering options. */ export type AttributeWhereInput = { /** List of conditions that must be met. */ AND?: InputMaybe>; @@ -2941,81 +3288,42 @@ export type AttributeWhereInput = { export type BulkAttributeValueInput = { /** The boolean value of an attribute to resolve. If the passed value is non-existent, it will be created. */ boolean?: InputMaybe; - /** - * File content type. - * - * Added in Saleor 3.12. - */ + /** File content type. */ contentType?: InputMaybe; - /** - * Represents the date value of the attribute value. - * - * Added in Saleor 3.12. - */ + /** Represents the date value of the attribute value. */ date?: InputMaybe; - /** - * Represents the date/time value of the attribute value. - * - * Added in Saleor 3.12. - */ + /** Represents the date/time value of the attribute value. */ dateTime?: InputMaybe; - /** - * Attribute value ID. - * - * Added in Saleor 3.12. - */ + /** Attribute value ID. */ dropdown?: InputMaybe; - /** - * External ID of this attribute. - * - * Added in Saleor 3.14. - */ + /** External ID of this attribute. */ externalReference?: InputMaybe; - /** - * URL of the file attribute. Every time, a new value is created. - * - * Added in Saleor 3.12. - */ + /** URL of the file attribute. Every time, a new value is created. */ file?: InputMaybe; /** ID of the selected attribute. */ id?: InputMaybe; - /** - * List of attribute value IDs. - * - * Added in Saleor 3.12. - */ + /** List of attribute value IDs. */ multiselect?: InputMaybe>; - /** - * Numeric value of an attribute. - * - * Added in Saleor 3.12. - */ + /** Numeric value of an attribute. */ numeric?: InputMaybe; - /** - * Plain text content. - * - * Added in Saleor 3.12. - */ + /** Plain text content. */ plainText?: InputMaybe; /** - * List of entity IDs that will be used as references. + * ID of the referenced entity for single reference attribute. * - * Added in Saleor 3.12. + * Added in Saleor 3.22. */ + reference?: InputMaybe; + /** List of entity IDs that will be used as references. */ references?: InputMaybe>; - /** - * Text content in JSON format. - * - * Added in Saleor 3.12. - */ + /** Text content in JSON format. */ richText?: InputMaybe; + /** Attribute value ID. */ + swatch?: InputMaybe; /** - * Attribute value ID. - * - * Added in Saleor 3.12. + * 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 */ - swatch?: InputMaybe; - /** The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.This field will be removed in Saleor 4.0. */ values?: InputMaybe>; }; @@ -3055,11 +3363,7 @@ export type BulkStockError = { values?: Maybe>; }; -/** - * Synchronous webhook for calculating checkout/order taxes. - * - * Added in Saleor 3.7. - */ +/** Synchronous webhook for calculating checkout/order taxes. */ export type CalculateTaxes = Event & { __typename?: 'CalculateTaxes'; /** Time of the event. */ @@ -3082,6 +3386,42 @@ export type CardInput = { money: MoneyInput; }; +/** + * Represents a card payment method used for a transaction. + * + * Added in Saleor 3.22. + */ +export type CardPaymentMethodDetails = PaymentMethodDetails & { + __typename?: 'CardPaymentMethodDetails'; + /** Card brand. */ + brand?: Maybe; + /** Two-digit number representing the card’s expiration month. */ + expMonth?: Maybe; + /** Four-digit number representing the card’s expiration year. */ + expYear?: Maybe; + /** First 4 digits of the card number. */ + firstDigits?: Maybe; + /** Last 4 digits of the card number. */ + lastDigits?: Maybe; + /** Name of the payment method. */ + name: Scalars['String']['output']; +}; + +export type CardPaymentMethodDetailsInput = { + /** Brand of the payment method used for the transaction. Max length is 40 characters. */ + brand?: InputMaybe; + /** Expiration month of the card used for the transaction. Value must be between 1 and 12. */ + expMonth?: InputMaybe; + /** Expiration year of the card used for the transaction. Value must be between 2000 and 9999. */ + expYear?: InputMaybe; + /** First digits of the card used for the transaction. Max length is 4 characters. */ + firstDigits?: InputMaybe; + /** Last digits of the card used for the transaction. Max length is 4 characters. */ + lastDigits?: InputMaybe; + /** Name of the payment method used for the transaction. Max length is 256 characters. */ + name: Scalars['String']['input']; +}; + export type CatalogueInput = { /** Categories related to the discount. */ categories?: InputMaybe>; @@ -3089,11 +3429,7 @@ export type CatalogueInput = { collections?: InputMaybe>; /** Products related to the discount. */ products?: InputMaybe>; - /** - * Product variant related to the discount. - * - * Added in Saleor 3.1. - */ + /** Product variant related to the discount. */ variants?: InputMaybe>; }; @@ -3131,7 +3467,7 @@ export type Category = Node & ObjectWithMetadata & { * Description of the category. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `description` field instead. + * @deprecated Use the `description` field instead. */ descriptionJson?: Maybe; /** The ID of the category. */ @@ -3144,15 +3480,9 @@ export type Category = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Name of category */ name: Scalars['String']['output']; @@ -3164,15 +3494,9 @@ export type Category = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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 products in the category. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. */ products?: Maybe; @@ -3184,11 +3508,7 @@ export type Category = Node & ObjectWithMetadata & { slug: Scalars['String']['output']; /** Returns translated category fields for the given language code. */ translation?: Maybe; - /** - * The date and time when the category was last updated. - * - * Added in Saleor 3.17. - */ + /** The date and time when the category was last updated. */ updatedAt: Scalars['DateTime']['output']; }; @@ -3250,6 +3570,7 @@ export type CategoryProductsArgs = { filter?: InputMaybe; first?: InputMaybe; last?: InputMaybe; + search?: InputMaybe; sortBy?: InputMaybe; where?: InputMaybe; }; @@ -3270,7 +3591,7 @@ export type CategoryBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -3300,15 +3621,11 @@ export type CategoryCreate = { __typename?: 'CategoryCreate'; category?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; - -/** - * Event sent when new category is created. - * - * Added in Saleor 3.2. - */ + +/** Event sent when new category is created. */ export type CategoryCreated = Event & { __typename?: 'CategoryCreated'; /** The category the event relates to. */ @@ -3332,15 +3649,11 @@ export type CategoryDelete = { __typename?: 'CategoryDelete'; category?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; -/** - * Event sent when category is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when category is deleted. */ export type CategoryDeleted = Event & { __typename?: 'CategoryDeleted'; /** The category the event relates to. */ @@ -3360,11 +3673,7 @@ export type CategoryFilterInput = { metadata?: InputMaybe>; search?: InputMaybe; slugs?: InputMaybe>; - /** - * Filter by when was the most recent update. - * - * Added in Saleor 3.17. - */ + /** Filter by when was the most recent update. */ updatedAt?: InputMaybe; }; @@ -3380,17 +3689,17 @@ export type CategoryInput = { */ description?: InputMaybe; /** - * Fields required to update the category metadata. + * Fields required to update the category metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Category name. */ name?: InputMaybe; /** - * Fields required to update the category private metadata. + * Fields required to update the category private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** Search engine optimization fields. */ @@ -3410,8 +3719,7 @@ export type CategorySortField = export type CategorySortingInput = { /** * Specifies the channel in which to sort the data. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. + * @deprecated Use root-level channel argument instead. */ channel?: InputMaybe; /** Specifies the direction in which to sort categories. */ @@ -3425,14 +3733,10 @@ export type CategoryTranslatableContent = Node & { __typename?: 'CategoryTranslatableContent'; /** * Represents a single category of products. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ category?: Maybe; - /** - * The ID of the category to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the category to translate. */ categoryId: Scalars['ID']['output']; /** * Category description to translate. @@ -3444,7 +3748,7 @@ export type CategoryTranslatableContent = Node & { * Description of the category. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `description` field instead. + * @deprecated Use the `description` field instead. */ descriptionJson?: Maybe; /** The ID of the category translatable content. */ @@ -3455,6 +3759,12 @@ export type CategoryTranslatableContent = Node & { seoDescription?: Maybe; /** SEO title to translate. */ seoTitle?: Maybe; + /** + * Slug to translate. + * + * Added in Saleor 3.21. + */ + slug?: Maybe; /** Returns translated category fields for the given language code. */ translation?: Maybe; }; @@ -3474,7 +3784,7 @@ export type CategoryTranslate = { __typename?: 'CategoryTranslate'; category?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; @@ -3491,7 +3801,7 @@ export type CategoryTranslation = Node & { * Translated description of the category. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `description` field instead. + * @deprecated Use the `description` field instead. */ descriptionJson?: Maybe; /** The ID of the category translation. */ @@ -3505,10 +3815,12 @@ export type CategoryTranslation = Node & { /** Translated SEO title. */ seoTitle?: Maybe; /** - * Represents the category fields to translate. + * Translated category slug. * - * Added in Saleor 3.14. + * Added in Saleor 3.21. */ + slug?: Maybe; + /** Represents the category fields to translate. */ translatableContent?: Maybe; }; @@ -3521,15 +3833,11 @@ export type CategoryUpdate = { __typename?: 'CategoryUpdate'; category?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; -/** - * Event sent when category is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when category is updated. */ export type CategoryUpdated = Event & { __typename?: 'CategoryUpdated'; /** The category the event relates to. */ @@ -3556,27 +3864,15 @@ export type CategoryWhereInput = { /** Represents channel. */ export type Channel = Node & ObjectWithMetadata & { __typename?: 'Channel'; - /** - * Shipping methods that are available for the channel. - * - * Added in Saleor 3.6. - */ + /** Shipping methods that are available for the channel. */ availableShippingMethodsPerCountry?: Maybe>; /** * Channel-specific checkout settings. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_CHANNELS, MANAGE_CHECKOUTS. */ checkoutSettings: CheckoutSettings; - /** - * List of shippable countries for the channel. - * - * Added in Saleor 3.6. - */ + /** List of shippable countries for the channel. */ countries?: Maybe>; /** * A currency that is assigned to the channel. @@ -3587,8 +3883,6 @@ export type Channel = Node & ObjectWithMetadata & { /** * Default country for the channel. Default country can be used in checkout to determine the stock quantities or calculate taxes when the country was not explicitly provided. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. */ defaultCountry: CountryDisplay; @@ -3606,25 +3900,15 @@ export type Channel = Node & ObjectWithMetadata & { * Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. */ isActive: Scalars['Boolean']['output']; - /** - * List of public metadata items. Can be accessed without permissions. - * - * Added in Saleor 3.15. - */ + /** List of public metadata items. Can be accessed without permissions. */ metadata: Array; /** * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.15. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.15. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** * Name of the channel. @@ -3635,48 +3919,30 @@ export type Channel = Node & ObjectWithMetadata & { /** * Channel-specific order settings. * - * Added in Saleor 3.12. - * * Requires one of the following permissions: MANAGE_CHANNELS, MANAGE_ORDERS. */ orderSettings: OrderSettings; /** * Channel-specific payment settings. * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_CHANNELS, HANDLE_PAYMENTS. */ paymentSettings: PaymentSettings; - /** - * List of private metadata items. Requires staff permissions to access. - * - * Added in Saleor 3.15. - */ + /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; /** * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.15. */ 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. - * - * Added in Saleor 3.15. - */ + /** 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; /** Slug of the channel. */ slug: Scalars['String']['output']; /** * Define the stock setting for this channel. * - * Added in Saleor 3.7. - * * Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. */ stockSettings: StockSettings; @@ -3691,8 +3957,6 @@ export type Channel = Node & ObjectWithMetadata & { /** * List of warehouses assigned to this channel. * - * Added in Saleor 3.5. - * * Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. */ warehouses: Array; @@ -3740,13 +4004,13 @@ export type ChannelActivate = { __typename?: 'ChannelActivate'; /** Activated channel. */ channel?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ channelErrors: Array; errors: Array; }; /** - * Creates new channel. + * Creates a new channel. * * Requires one of the following permissions: MANAGE_CHANNELS. * @@ -3756,7 +4020,7 @@ export type ChannelActivate = { export type ChannelCreate = { __typename?: 'ChannelCreate'; channel?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ channelErrors: Array; errors: Array; }; @@ -3764,73 +4028,41 @@ export type ChannelCreate = { export type ChannelCreateInput = { /** List of shipping zones to assign to the channel. */ addShippingZones?: InputMaybe>; - /** - * List of warehouses to assign to the channel. - * - * Added in Saleor 3.5. - */ + /** List of warehouses to assign to the channel. */ addWarehouses?: InputMaybe>; - /** - * The channel checkout settings - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The channel checkout settings */ checkoutSettings?: InputMaybe; /** Currency of the channel. */ currencyCode: Scalars['String']['input']; - /** - * Default country for the channel. Default country can be used in checkout to determine the stock quantities or calculate taxes when the country was not explicitly provided. - * - * Added in Saleor 3.1. - */ + /** 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. */ defaultCountry: CountryCode; /** Determine if channel will be set active or not. */ isActive?: InputMaybe; /** - * Channel public metadata. + * Channel public metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.15. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Name of the channel. */ name: Scalars['String']['input']; - /** - * The channel order settings - * - * Added in Saleor 3.12. - */ + /** The channel order settings */ orderSettings?: InputMaybe; - /** - * The channel payment settings - * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The channel payment settings */ paymentSettings?: InputMaybe; /** - * Channel private metadata. + * Channel private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.15. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** Slug of the channel. */ slug: Scalars['String']['input']; - /** - * The channel stock settings. - * - * Added in Saleor 3.7. - */ + /** The channel stock settings. */ stockSettings?: InputMaybe; }; -/** - * Event sent when new channel is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new channel is created. */ export type ChannelCreated = Event & { __typename?: 'ChannelCreated'; /** The channel the event relates to. */ @@ -3857,13 +4089,13 @@ export type ChannelDeactivate = { __typename?: 'ChannelDeactivate'; /** Deactivated channel. */ channel?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ channelErrors: Array; errors: Array; }; /** - * Delete a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. + * Deletes a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. * * Requires one of the following permissions: MANAGE_CHANNELS. * @@ -3873,21 +4105,17 @@ export type ChannelDeactivate = { export type ChannelDelete = { __typename?: 'ChannelDelete'; channel?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ channelErrors: Array; errors: Array; }; export type ChannelDeleteInput = { - /** ID of channel to migrate orders from origin channel. */ + /** ID of a channel to migrate orders from the origin channel. Target channel has to have the same currency as the origin. */ channelId: Scalars['ID']['input']; }; -/** - * Event sent when channel is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when channel is deleted. */ export type ChannelDeleted = Event & { __typename?: 'ChannelDeleted'; /** The channel the event relates to. */ @@ -3916,7 +4144,6 @@ export type ChannelError = { warehouses?: Maybe>; }; -/** An enumeration. */ export type ChannelErrorCode = | 'ALREADY_EXISTS' | 'CHANNELS_CURRENCY_MUST_BE_THE_SAME' @@ -3937,13 +4164,11 @@ export type ChannelListingUpdateInput = { preorderThreshold?: InputMaybe; /** Price of the particular variant in channel. */ price?: InputMaybe; + /** Price of the variant before discount. */ + priorPrice?: InputMaybe; }; -/** - * Event sent when channel metadata is updated. - * - * Added in Saleor 3.15. - */ +/** Event sent when channel metadata is updated. */ export type ChannelMetadataUpdated = Event & { __typename?: 'ChannelMetadataUpdated'; /** The channel the event relates to. */ @@ -3961,8 +4186,6 @@ export type ChannelMetadataUpdated = Event & { /** * Reorder the warehouses of a channel. * - * Added in Saleor 3.7. - * * Requires one of the following permissions: MANAGE_CHANNELS. */ export type ChannelReorderWarehouses = { @@ -3972,11 +4195,7 @@ export type ChannelReorderWarehouses = { errors: Array; }; -/** - * Event sent when channel status has changed. - * - * Added in Saleor 3.2. - */ +/** Event sent when channel status has changed. */ export type ChannelStatusChanged = Event & { __typename?: 'ChannelStatusChanged'; /** The channel the event relates to. */ @@ -4006,7 +4225,7 @@ export type ChannelStatusChanged = Event & { export type ChannelUpdate = { __typename?: 'ChannelUpdate'; channel?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ channelErrors: Array; errors: Array; }; @@ -4014,79 +4233,43 @@ export type ChannelUpdate = { export type ChannelUpdateInput = { /** List of shipping zones to assign to the channel. */ addShippingZones?: InputMaybe>; - /** - * List of warehouses to assign to the channel. - * - * Added in Saleor 3.5. - */ + /** List of warehouses to assign to the channel. */ addWarehouses?: InputMaybe>; - /** - * The channel checkout settings - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The channel checkout settings */ checkoutSettings?: InputMaybe; - /** - * Default country for the channel. Default country can be used in checkout to determine the stock quantities or calculate taxes when the country was not explicitly provided. - * - * Added in Saleor 3.1. - */ + /** 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. */ defaultCountry?: InputMaybe; /** Determine if channel will be set active or not. */ isActive?: InputMaybe; /** - * Channel public metadata. + * Channel public metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.15. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Name of the channel. */ name?: InputMaybe; - /** - * The channel order settings - * - * Added in Saleor 3.12. - */ + /** The channel order settings */ orderSettings?: InputMaybe; - /** - * The channel payment settings - * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The channel payment settings */ paymentSettings?: InputMaybe; /** - * Channel private metadata. + * Channel private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.15. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** List of shipping zones to unassign from the channel. */ removeShippingZones?: InputMaybe>; - /** - * List of warehouses to unassign from the channel. - * - * Added in Saleor 3.5. - */ + /** List of warehouses to unassign from the channel. */ removeWarehouses?: InputMaybe>; /** Slug of the channel. */ slug?: InputMaybe; - /** - * The channel stock settings. - * - * Added in Saleor 3.7. - */ + /** The channel stock settings. */ stockSettings?: InputMaybe; }; -/** - * Event sent when channel is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when channel is updated. */ export type ChannelUpdated = Event & { __typename?: 'ChannelUpdated'; /** The channel the event relates to. */ @@ -4107,19 +4290,11 @@ export type Checkout = Node & ObjectWithMetadata & { /** * The authorize status of the checkout. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Triggers the following webhook events: * - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired. */ authorizeStatus: CheckoutAuthorizeStatusEnum; - /** - * Collection points that can be used for this order. - * - * Added in Saleor 3.1. - */ + /** Collection points that can be used for this order. */ availableCollectionPoints: Array; /** * List of available payment gateways. @@ -4134,7 +4309,7 @@ export type Checkout = Node & ObjectWithMetadata & { * 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. - * @deprecated This field will be removed in Saleor 4.0. Use `shippingMethods` instead. + * @deprecated Use `shippingMethods` instead. */ availableShippingMethods: Array; /** The billing address of the checkout. */ @@ -4144,10 +4319,6 @@ export type Checkout = Node & ObjectWithMetadata & { /** * The charge status of the checkout. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Triggers the following webhook events: * - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired. */ @@ -4155,9 +4326,13 @@ export type Checkout = Node & ObjectWithMetadata & { /** The date and time when the checkout was created. */ created: Scalars['DateTime']['output']; /** - * The delivery method selected for this checkout. + * The customer note for the checkout. * - * Added in Saleor 3.1. + * Added in Saleor 3.21. + */ + customerNote: Scalars['String']['output']; + /** + * 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. @@ -4168,11 +4343,7 @@ export type Checkout = Node & ObjectWithMetadata & { discount?: Maybe; /** The name of voucher assigned to the checkout. */ discountName?: Maybe; - /** - * Determines whether displayed prices should include taxes. - * - * Added in Saleor 3.9. - */ + /** Determines whether displayed prices should include taxes. */ displayGrossPrices: Scalars['Boolean']['output']; /** Email of a customer. */ email?: Maybe; @@ -4184,7 +4355,7 @@ export type Checkout = Node & ObjectWithMetadata & { isShippingRequired: Scalars['Boolean']['output']; /** Checkout language code. */ languageCode: LanguageCodeEnum; - /** @deprecated This field will be removed in Saleor 4.0. Use `updatedAt` instead. */ + /** @deprecated Use `updatedAt` instead. */ lastChange: Scalars['DateTime']['output']; /** A list of checkout lines, each containing information about an item in the checkout. */ lines: Array; @@ -4194,17 +4365,14 @@ export type Checkout = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ + metafields?: Maybe; /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. + * The note for the checkout. + * @deprecated Use `customerNote` instead. */ - metafields?: Maybe; - /** The note for the checkout. */ note: Scalars['String']['output']; /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; @@ -4212,23 +4380,11 @@ export type Checkout = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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 with the checkout. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of problems with the checkout. */ problems?: Maybe>; /** The number of items purchased. */ quantity: Scalars['Int']['output']; @@ -4240,7 +4396,7 @@ export type Checkout = Node & ObjectWithMetadata & { * 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. - * @deprecated This field will be removed in Saleor 4.0. Use `deliveryMethod` instead. + * @deprecated Use `deliveryMethod` instead. */ shippingMethod?: Maybe; /** @@ -4258,19 +4414,9 @@ export type Checkout = Node & ObjectWithMetadata & { * - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired. */ shippingPrice: TaxedMoney; - /** - * Date when oldest stock reservation for this checkout expires or null if no stock is reserved. - * - * Added in Saleor 3.1. - */ + /** Date when oldest stock reservation for this checkout expires or null if no stock is reserved. */ stockReservationExpires?: Maybe; - /** - * 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. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** 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?: Maybe>; /** * The price of the checkout before shipping, with taxes included. @@ -4279,21 +4425,13 @@ export type Checkout = Node & ObjectWithMetadata & { * - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired. */ subtotalPrice: TaxedMoney; - /** - * Returns True if checkout has to be exempt from taxes. - * - * Added in Saleor 3.8. - */ + /** Returns True if checkout has to be exempt from taxes. */ taxExemption: Scalars['Boolean']['output']; /** The checkout's token. */ token: Scalars['UUID']['output']; /** * The difference between the paid and the checkout total amount. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Triggers the following webhook events: * - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired. */ @@ -4305,21 +4443,11 @@ export type Checkout = Node & ObjectWithMetadata & { * - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired. */ totalPrice: TaxedMoney; - /** - * List of transactions for the checkout. Requires one of the following permissions: MANAGE_CHECKOUTS, HANDLE_PAYMENTS. - * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of transactions for the checkout. Requires one of the following permissions: MANAGE_CHECKOUTS, HANDLE_PAYMENTS. */ transactions?: Maybe>; /** 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?: Maybe; - /** - * Time of last modification of the given checkout. - * - * Added in Saleor 3.13. - */ + /** Time of last modification of the given checkout. */ updatedAt: Scalars['DateTime']['output']; /** The user assigned to the checkout. Requires one of the following permissions: MANAGE_USERS, HANDLE_PAYMENTS, OWNER. */ user?: Maybe; @@ -4375,7 +4503,7 @@ export type CheckoutAddPromoCode = { __typename?: 'CheckoutAddPromoCode'; /** The checkout with the added gift card or voucher. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; @@ -4408,8 +4536,17 @@ export type CheckoutAuthorizeStatusEnum = | 'NONE' | 'PARTIAL'; +export type CheckoutAutoCompleteInput = { + /** Specifies the earliest date on which fully paid checkouts can begin to be automatically completed. Fully paid checkouts dated before this cut-off will not be automatically completed. Must be less than the threshold of the oldest modified checkout eligible for automatic completion. Default is current date time. */ + cutOffDate?: InputMaybe; + /** The time in minutes after which the fully paid checkout will be automatically completed. Default is 30. Set to 0 for immediate completion. Should be less than the threshold for the oldest modified checkout eligible for automatic completion. */ + delay?: InputMaybe; + /** 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. */ + enabled: Scalars['Boolean']['input']; +}; + /** - * Update billing address in the existing checkout. + * Updates billing address in the existing checkout. * * Triggers the following webhook events: * - CHECKOUT_UPDATED (async): A checkout was updated. @@ -4418,7 +4555,7 @@ export type CheckoutBillingAddressUpdate = { __typename?: 'CheckoutBillingAddressUpdate'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; @@ -4462,7 +4599,7 @@ export type CheckoutChargeStatusEnum = */ export type CheckoutComplete = { __typename?: 'CheckoutComplete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; /** Confirmation data used to process additional authorization steps. */ confirmationData?: Maybe; @@ -4501,23 +4638,17 @@ export type CheckoutCountableEdge = { export type CheckoutCreate = { __typename?: 'CheckoutCreate'; checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; /** * 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. - * @deprecated This field will be removed in Saleor 4.0. Always returns `true`. + * @deprecated Always returns `true`. */ created?: Maybe; errors: Array; }; -/** - * Create new checkout from existing order. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Creates a new checkout from existing order. */ export type CheckoutCreateFromOrder = { __typename?: 'CheckoutCreateFromOrder'; /** Created checkout. */ @@ -4537,7 +4668,6 @@ export type CheckoutCreateFromOrderError = { message?: Maybe; }; -/** An enumeration. */ export type CheckoutCreateFromOrderErrorCode = | 'CHANNEL_INACTIVE' | 'GRAPHQL_ERROR' @@ -4557,7 +4687,6 @@ export type CheckoutCreateFromOrderUnavailableVariant = { variantId: Scalars['ID']['output']; }; -/** An enumeration. */ export type CheckoutCreateFromOrderUnavailableVariantErrorCode = | 'INSUFFICIENT_STOCK' | 'NOT_FOUND' @@ -4577,21 +4706,43 @@ export type CheckoutCreateInput = { languageCode?: InputMaybe; /** A list of checkout lines, each containing information about an item in the checkout. */ lines: Array; - /** The mailing address to where the checkout will be shipped. Note: the address will be ignored if the checkout doesn't contain shippable items. `skipValidation` requires HANDLE_CHECKOUTS and AUTHENTICATED_APP permissions. */ - shippingAddress?: InputMaybe; /** - * The checkout validation rules that can be changed. + * Checkout public metadata. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + * + * Added in Saleor 3.21. + */ + metadata?: InputMaybe>; + /** + * Checkout private metadata. Requires one of the following permissions: MANAGE_CHECKOUTS, HANDLE_CHECKOUTS + * + * Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + * + * Added in Saleor 3.21. + */ + privateMetadata?: InputMaybe>; + /** + * Indicates whether the billing address should be saved to the user’s address book upon checkout completion. Can only be set when a billing address is provided. If not specified along with the address, the default behavior is to save the address. + * + * Added in Saleor 3.21. + */ + saveBillingAddress?: InputMaybe; + /** + * Indicates whether the shipping address should be saved to the user’s address book upon checkout completion.Can only be set when a shipping address is provided. If not specified along with the address, the default behavior is to save the address. * - * Added in Saleor 3.5. + * Added in Saleor 3.21. */ + saveShippingAddress?: InputMaybe; + /** The mailing address to where the checkout will be shipped. Note: the address will be ignored if the checkout doesn't contain shippable items. `skipValidation` requires HANDLE_CHECKOUTS and AUTHENTICATED_APP permissions. */ + shippingAddress?: InputMaybe; + /** The checkout validation rules that can be changed. */ validationRules?: InputMaybe; }; -/** - * Event sent when new checkout is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new checkout is created. */ export type CheckoutCreated = Event & { __typename?: 'CheckoutCreated'; /** The checkout the event relates to. */ @@ -4618,7 +4769,7 @@ export type CheckoutCustomerAttach = { __typename?: 'CheckoutCustomerAttach'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; @@ -4635,15 +4786,30 @@ export type CheckoutCustomerDetach = { __typename?: 'CheckoutCustomerDetach'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; /** - * 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. + * Updates customer note in the existing checkout object. + * + * Added in Saleor 3.21. * - * Added in Saleor 3.1. + * Triggers the following webhook events: + * - CHECKOUT_UPDATED (async): A checkout was updated. + */ +export type CheckoutCustomerNoteUpdate = { + __typename?: 'CheckoutCustomerNoteUpdate'; + /** An updated checkout. */ + checkout?: Maybe; + /** @deprecated Use `errors` field instead. */ + checkoutErrors: Array; + errors: Array; +}; + +/** + * 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. * * Triggers the following webhook events: * - SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Triggered when updating the checkout delivery method with the external one. @@ -4666,7 +4832,7 @@ export type CheckoutEmailUpdate = { __typename?: 'CheckoutEmailUpdate'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; @@ -4687,7 +4853,6 @@ export type CheckoutError = { variants?: Maybe>; }; -/** An enumeration. */ export type CheckoutErrorCode = | 'BILLING_ADDRESS_NOT_SET' | 'CHANNEL_INACTIVE' @@ -4700,6 +4865,7 @@ export type CheckoutErrorCode = | 'INSUFFICIENT_STOCK' | 'INVALID' | 'INVALID_SHIPPING_METHOD' + | 'MISSING_ADDRESS_DATA' | 'MISSING_CHANNEL_SLUG' | 'NON_EDITABLE_GIFT_LINE' | 'NON_REMOVABLE_GIFT_LINE' @@ -4732,11 +4898,7 @@ export type CheckoutFilterInput = { updatedAt?: InputMaybe; }; -/** - * Filter shipping methods for checkout. - * - * Added in Saleor 3.6. - */ +/** Filter shipping methods for checkout. */ export type CheckoutFilterShippingMethods = Event & { __typename?: 'CheckoutFilterShippingMethods'; /** The checkout the event relates to. */ @@ -4747,22 +4909,35 @@ export type CheckoutFilterShippingMethods = Event & { issuingPrincipal?: Maybe; /** The application receiving the webhook. */ recipient?: Maybe; - /** - * Shipping methods that can be used with this checkout. - * - * Added in Saleor 3.6. - */ + /** Shipping methods that can be used with this checkout. */ shippingMethods?: Maybe>; /** Saleor version that triggered the event. */ version?: Maybe; }; /** - * Event sent when checkout is fully paid with transactions. + * Event sent when a checkout was fully authorized. A checkout is considered fully authorized when its `authorizeStatus` is `FULL`. * - * Added in Saleor 3.13. + * It is triggered only for checkouts whose payments are processed through the Transaction API. + */ +export type CheckoutFullyAuthorized = Event & { + __typename?: 'CheckoutFullyAuthorized'; + /** The checkout the event relates to. */ + checkout?: Maybe; + /** Time of the event. */ + issuedAt?: Maybe; + /** The user or application that triggered the event. */ + issuingPrincipal?: Maybe; + /** The application receiving the webhook. */ + recipient?: Maybe; + /** Saleor version that triggered the event. */ + version?: Maybe; +}; + +/** + * Event sent when a checkout was fully paid. A checkout is considered fully paid when its `chargeStatus` is `FULL` or `OVERCHARGED`. This event is not sent if payments are only authorized but not fully charged. * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * It is triggered only for checkouts whose payments are processed through the Transaction API. */ export type CheckoutFullyPaid = Event & { __typename?: 'CheckoutFullyPaid'; @@ -4779,7 +4954,7 @@ export type CheckoutFullyPaid = Event & { }; /** - * Update language code in the existing checkout. + * Updates language code in the existing checkout. * * Triggers the following webhook events: * - CHECKOUT_UPDATED (async): A checkout was updated. @@ -4788,7 +4963,7 @@ export type CheckoutLanguageCodeUpdate = { __typename?: 'CheckoutLanguageCodeUpdate'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; @@ -4806,53 +4981,39 @@ export type CheckoutLine = Node & ObjectWithMetadata & { * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ isGift?: Maybe; - /** - * List of public metadata items. Can be accessed without permissions. - * - * Added in Saleor 3.5. - */ + /** List of public metadata items. Can be accessed without permissions. */ metadata: Array; /** * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.5. */ metafield?: Maybe; + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ + metafields?: Maybe; /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. + * The sum of the checkout line price prior to promotion. * - * Added in Saleor 3.5. + * Added in Saleor 3.21. */ - metafields?: Maybe; + priorTotalPrice?: Maybe; /** - * List of private metadata items. Requires staff permissions to access. + * The unit price of the checkout line prior to promotion. * - * Added in Saleor 3.5. + * Added in Saleor 3.21. */ + priorUnitPrice?: Maybe; + /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; /** * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.5. */ 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. - * - * Added in Saleor 3.5. - */ + /** 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 with the checkout line. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of problems with the checkout line. */ problems?: Maybe>; /** The quantity of product variant assigned to the checkout line. */ quantity: Scalars['Int']['output']; @@ -4931,29 +5092,21 @@ export type CheckoutLineDelete = { __typename?: 'CheckoutLineDelete'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; export type CheckoutLineInput = { - /** - * Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. - * - * Added in Saleor 3.6. - */ + /** 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. + * Fields required to update the object's metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; - /** - * Custom price of the item. Can be set only by apps with `HANDLE_CHECKOUTS` permission. When the line with the same variant will be provided multiple times, the last price will be used. - * - * Added in Saleor 3.1. - */ + /** Custom price of the item. Can be set only by apps with `HANDLE_CHECKOUTS` permission. When the line with the same variant will be provided multiple times, the last price will be used. */ price?: InputMaybe; /** The number of items purchased. */ quantity: Scalars['Int']['input']; @@ -4961,22 +5114,10 @@ export type CheckoutLineInput = { variantId: Scalars['ID']['input']; }; -/** - * Represents an problem in the checkout line. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents an problem in the checkout line. */ export type CheckoutLineProblem = CheckoutLineProblemInsufficientStock | CheckoutLineProblemVariantNotAvailable; -/** - * Indicates insufficient stock for a given checkout line.Placing the order will not be possible until solving this problem. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Indicates insufficient stock for a given checkout line.Placing the order will not be possible until solving this problem. */ export type CheckoutLineProblemInsufficientStock = { __typename?: 'CheckoutLineProblemInsufficientStock'; /** Available quantity of a variant. */ @@ -4987,13 +5128,7 @@ export type CheckoutLineProblemInsufficientStock = { variant: ProductVariant; }; -/** - * The variant assigned to the checkout line is not available.Placing the order will not be possible until solving this problem. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** The variant assigned to the checkout line is not available.Placing the order will not be possible until solving this problem. */ export type CheckoutLineProblemVariantNotAvailable = { __typename?: 'CheckoutLineProblemVariantNotAvailable'; /** The line that has variant that is not available. */ @@ -5001,24 +5136,23 @@ export type CheckoutLineProblemVariantNotAvailable = { }; export type CheckoutLineUpdateInput = { - /** - * ID of the line. - * - * Added in Saleor 3.6. - */ + /** ID of the line. */ lineId?: InputMaybe; /** - * Custom price of the item. Can be set only by apps with `HANDLE_CHECKOUTS` permission. When the line with the same variant will be provided multiple times, the last price will be used. + * Checkout line public metadata. Will add and update keys. To delete keys use deleteMetadata mutation. * - * Added in Saleor 3.1. + * Added in Saleor 3.21. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. */ + metadata?: InputMaybe>; + /** Custom price of the item. Can be set only by apps with `HANDLE_CHECKOUTS` permission. When the line with the same variant will be provided multiple times, the last price will be used. */ price?: InputMaybe; /** The number of items purchased. Optional for apps, required for any other users. */ quantity?: InputMaybe; /** * ID of the product variant. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `lineId` instead. + * @deprecated Use `lineId` instead. */ variantId?: InputMaybe; }; @@ -5033,7 +5167,7 @@ export type CheckoutLinesAdd = { __typename?: 'CheckoutLinesAdd'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; @@ -5061,16 +5195,12 @@ export type CheckoutLinesUpdate = { __typename?: 'CheckoutLinesUpdate'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; -/** - * Event sent when checkout metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when checkout metadata is updated. */ export type CheckoutMetadataUpdated = Event & { __typename?: 'CheckoutMetadataUpdated'; /** The checkout the event relates to. */ @@ -5085,7 +5215,7 @@ export type CheckoutMetadataUpdated = Event & { version?: Maybe; }; -/** Create a new payment for given checkout. */ +/** Creates a new payment for given checkout. */ export type CheckoutPaymentCreate = { __typename?: 'CheckoutPaymentCreate'; /** Related checkout object. */ @@ -5093,17 +5223,11 @@ export type CheckoutPaymentCreate = { errors: Array; /** A newly created payment. */ payment?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ paymentErrors: Array; }; -/** - * Represents an problem in the checkout. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents an problem in the checkout. */ export type CheckoutProblem = CheckoutLineProblemInsufficientStock | CheckoutLineProblemVariantNotAvailable; /** @@ -5116,41 +5240,59 @@ export type CheckoutRemovePromoCode = { __typename?: 'CheckoutRemovePromoCode'; /** The checkout with the removed gift card or voucher. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; -/** - * Represents the channel-specific checkout settings. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the channel-specific checkout settings. */ export type CheckoutSettings = { __typename?: '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. + * 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?: Maybe; + /** + * The time in minutes to wait after a checkout is fully paid before automatically completing it. * - * Added in Saleor 3.15.This field will be removed in Saleor 4.0. + * Added in Saleor 3.22. + */ + automaticCompletionDelay?: Maybe; + /** + * 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: Scalars['Boolean']['output']; + /** 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: Scalars['Boolean']['output']; }; export type 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. + * Settings for automatic completion of fully paid checkouts. * - * Added in Saleor 3.15. + * Added in Saleor 3.22. + */ + automaticCompletion?: InputMaybe; + /** + * 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. * - * DEPRECATED: this field will be removed in Saleor 4.0. + * Added in Saleor 3.20. + * @deprecated 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 */ useLegacyErrorFlow?: InputMaybe; }; /** - * Update shipping address in the existing checkout. + * Updates shipping address in the existing checkout. * * Triggers the following webhook events: * - CHECKOUT_UPDATED (async): A checkout was updated. @@ -5159,7 +5301,7 @@ export type CheckoutShippingAddressUpdate = { __typename?: 'CheckoutShippingAddressUpdate'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; @@ -5175,7 +5317,7 @@ export type CheckoutShippingMethodUpdate = { __typename?: 'CheckoutShippingMethodUpdate'; /** An updated checkout. */ checkout?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ checkoutErrors: Array; errors: Array; }; @@ -5195,11 +5337,7 @@ export type CheckoutSortingInput = { field: CheckoutSortField; }; -/** - * Event sent when checkout is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when checkout is updated. */ export type CheckoutUpdated = Event & { __typename?: 'CheckoutUpdated'; /** The checkout the event relates to. */ @@ -5229,6 +5367,15 @@ export type ChoiceValue = { verbose?: Maybe; }; +/** Enum determining the state of a circuit breaker. */ +export type CircuitBreakerStateEnum = + /** The breaker is conducting (requests are passing through). */ + | 'CLOSED' + /** 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. */ + | 'HALF_OPEN' + /** The breaker is tripped (no requests are passing). Breaker will enter half-open state after cooldown period. */ + | 'OPEN'; + /** Represents a collection of products. */ export type Collection = Node & ObjectWithMetadata & { __typename?: 'Collection'; @@ -5252,7 +5399,7 @@ export type Collection = Node & ObjectWithMetadata & { * Description of the collection. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `description` field instead. + * @deprecated Use the `description` field instead. */ descriptionJson?: Maybe; /** The ID of the collection. */ @@ -5263,15 +5410,9 @@ export type Collection = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Name of the collection. */ name: Scalars['String']['output']; @@ -5281,15 +5422,9 @@ export type Collection = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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 products in this collection. */ products?: Maybe; @@ -5342,6 +5477,7 @@ export type CollectionProductsArgs = { filter?: InputMaybe; first?: InputMaybe; last?: InputMaybe; + search?: InputMaybe; sortBy?: InputMaybe; where?: InputMaybe; }; @@ -5361,7 +5497,7 @@ export type CollectionAddProducts = { __typename?: 'CollectionAddProducts'; /** Collection to which products will be added. */ collection?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ collectionErrors: Array; errors: Array; }; @@ -5373,7 +5509,7 @@ export type CollectionAddProducts = { */ export type CollectionBulkDelete = { __typename?: 'CollectionBulkDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ collectionErrors: Array; /** Returns how many objects were affected. */ count: Scalars['Int']['output']; @@ -5389,13 +5525,9 @@ export type CollectionChannelListing = Node & { id: Scalars['ID']['output']; /** Indicates if the collection is published in the channel. */ isPublished: Scalars['Boolean']['output']; - /** @deprecated This field will be removed in Saleor 4.0. Use the `publishedAt` field to fetch the publication date. */ + /** @deprecated Use the `publishedAt` field to fetch the publication date. */ publicationDate?: Maybe; - /** - * The collection publication date. - * - * Added in Saleor 3.3. - */ + /** The collection publication date. */ publishedAt?: Maybe; }; @@ -5424,7 +5556,7 @@ export type CollectionChannelListingUpdate = { __typename?: 'CollectionChannelListingUpdate'; /** An updated collection instance. */ collection?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ collectionChannelListingErrors: Array; errors: Array; }; @@ -5462,7 +5594,7 @@ export type CollectionCountableEdge = { export type CollectionCreate = { __typename?: 'CollectionCreate'; collection?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ collectionErrors: Array; errors: Array; }; @@ -5481,25 +5613,24 @@ export type CollectionCreateInput = { /** Informs whether a collection is published. */ isPublished?: InputMaybe; /** - * Fields required to update the collection metadata. + * Fields required to update the collection metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Name of the collection. */ name?: InputMaybe; /** - * Fields required to update the collection private metadata. + * Fields required to update the collection private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** List of products to be added to the collection. */ products?: InputMaybe>; /** * Publication date. ISO 8601 standard. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ publicationDate?: InputMaybe; /** Search engine optimization fields. */ @@ -5508,11 +5639,7 @@ export type CollectionCreateInput = { slug?: InputMaybe; }; -/** - * Event sent when new collection is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new collection is created. */ export type CollectionCreated = Event & { __typename?: 'CollectionCreated'; /** The collection the event relates to. */ @@ -5528,11 +5655,7 @@ export type CollectionCreated = Event & { }; -/** - * Event sent when new collection is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new collection is created. */ export type CollectionCreatedCollectionArgs = { channel?: InputMaybe; }; @@ -5545,16 +5668,12 @@ export type CollectionCreatedCollectionArgs = { export type CollectionDelete = { __typename?: 'CollectionDelete'; collection?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ collectionErrors: Array; errors: Array; }; -/** - * Event sent when collection is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when collection is deleted. */ export type CollectionDeleted = Event & { __typename?: 'CollectionDeleted'; /** The collection the event relates to. */ @@ -5570,11 +5689,7 @@ export type CollectionDeleted = Event & { }; -/** - * Event sent when collection is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when collection is deleted. */ export type CollectionDeletedCollectionArgs = { channel?: InputMaybe; }; @@ -5591,7 +5706,6 @@ export type CollectionError = { products?: Maybe>; }; -/** An enumeration. */ export type CollectionErrorCode = | 'CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT' | 'DUPLICATED_INPUT_ITEM' @@ -5604,8 +5718,7 @@ export type CollectionErrorCode = export type CollectionFilterInput = { /** * Specifies the channel by which the data should be filtered. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. + * @deprecated Use root-level channel argument instead. */ channel?: InputMaybe; ids?: InputMaybe>; @@ -5629,23 +5742,22 @@ export type CollectionInput = { /** Informs whether a collection is published. */ isPublished?: InputMaybe; /** - * Fields required to update the collection metadata. + * Fields required to update the collection metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Name of the collection. */ name?: InputMaybe; /** - * Fields required to update the collection private metadata. + * Fields required to update the collection private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** * Publication date. ISO 8601 standard. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ publicationDate?: InputMaybe; /** Search engine optimization fields. */ @@ -5654,11 +5766,7 @@ export type CollectionInput = { slug?: InputMaybe; }; -/** - * Event sent when collection metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when collection metadata is updated. */ export type CollectionMetadataUpdated = Event & { __typename?: 'CollectionMetadataUpdated'; /** The collection the event relates to. */ @@ -5674,11 +5782,7 @@ export type CollectionMetadataUpdated = Event & { }; -/** - * Event sent when collection metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when collection metadata is updated. */ export type CollectionMetadataUpdatedCollectionArgs = { channel?: InputMaybe; }; @@ -5696,7 +5800,7 @@ export type CollectionRemoveProducts = { __typename?: 'CollectionRemoveProducts'; /** Collection from which products will be removed. */ collection?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ collectionErrors: Array; errors: Array; }; @@ -5710,7 +5814,7 @@ export type CollectionReorderProducts = { __typename?: 'CollectionReorderProducts'; /** Collection from which products are reordered. */ collection?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ collectionErrors: Array; errors: Array; }; @@ -5733,7 +5837,7 @@ export type CollectionSortField = */ | 'PUBLICATION_DATE' /** - * Sort collections by publication date. + * Sort collections by published at. * * This option requires a channel filter to work as the values can vary between channels. */ @@ -5742,8 +5846,7 @@ export type CollectionSortField = export type CollectionSortingInput = { /** * Specifies the channel in which to sort the data. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. + * @deprecated Use root-level channel argument instead. */ channel?: InputMaybe; /** Specifies the direction in which to sort collections. */ @@ -5757,14 +5860,10 @@ export type CollectionTranslatableContent = Node & { __typename?: 'CollectionTranslatableContent'; /** * Represents a collection of products. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ collection?: Maybe; - /** - * The ID of the collection to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the collection to translate. */ collectionId: Scalars['ID']['output']; /** * Collection's description to translate. @@ -5776,7 +5875,7 @@ export type CollectionTranslatableContent = Node & { * Description of the collection. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `description` field instead. + * @deprecated Use the `description` field instead. */ descriptionJson?: Maybe; /** The ID of the collection translatable content. */ @@ -5787,6 +5886,12 @@ export type CollectionTranslatableContent = Node & { seoDescription?: Maybe; /** SEO title to translate. */ seoTitle?: Maybe; + /** + * Slug to translate + * + * Added in Saleor 3.21. + */ + slug?: Maybe; /** Returns translated collection fields for the given language code. */ translation?: Maybe; }; @@ -5806,7 +5911,7 @@ export type CollectionTranslate = { __typename?: 'CollectionTranslate'; collection?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; @@ -5823,7 +5928,7 @@ export type CollectionTranslation = Node & { * Translated description of the collection. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `description` field instead. + * @deprecated Use the `description` field instead. */ descriptionJson?: Maybe; /** The ID of the collection translation. */ @@ -5837,10 +5942,12 @@ export type CollectionTranslation = Node & { /** Translated SEO title. */ seoTitle?: Maybe; /** - * Represents the collection fields to translate. + * Translated collection slug. * - * Added in Saleor 3.14. + * Added in Saleor 3.21. */ + slug?: Maybe; + /** Represents the collection fields to translate. */ translatableContent?: Maybe; }; @@ -5852,16 +5959,12 @@ export type CollectionTranslation = Node & { export type CollectionUpdate = { __typename?: 'CollectionUpdate'; collection?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ collectionErrors: Array; errors: Array; }; -/** - * Event sent when collection is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when collection is updated. */ export type CollectionUpdated = Event & { __typename?: 'CollectionUpdated'; /** The collection the event relates to. */ @@ -5877,11 +5980,7 @@ export type CollectionUpdated = Event & { }; -/** - * Event sent when collection is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when collection is updated. */ export type CollectionUpdatedCollectionArgs = { channel?: InputMaybe; }; @@ -5917,7 +6016,6 @@ export type ConfigurationItemInput = { value?: InputMaybe; }; -/** An enumeration. */ export type ConfigurationTypeFieldEnum = | 'BOOLEAN' | 'MULTILINE' @@ -5935,7 +6033,7 @@ export type ConfigurationTypeFieldEnum = */ export type ConfirmAccount = { __typename?: 'ConfirmAccount'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** An activated user account. */ @@ -5954,13 +6052,21 @@ export type ConfirmAccount = { */ export type ConfirmEmailChange = { __typename?: 'ConfirmEmailChange'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** A user instance with a new email. */ user?: Maybe; }; +/** Define the filtering options for fields that can contain multiple values. */ +export type ContainsFilterInput = { + /** The field contains all of the specified values. */ + containsAll?: InputMaybe>; + /** The field contains at least one of the specified values. */ + containsAny?: InputMaybe>; +}; + /** * Represents country codes defined by the ISO 3166-1 alpha-2 standard. * @@ -6212,12 +6318,23 @@ export type CountryCode = | 'VU' | 'WF' | 'WS' + | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW'; +/** Filter by country code. */ +export type CountryCodeEnumFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value not included in. */ + notOneOf?: InputMaybe>; + /** The value included in. */ + oneOf?: InputMaybe>; +}; + export type CountryDisplay = { __typename?: 'CountryDisplay'; /** Country code. */ @@ -6226,7 +6343,7 @@ export type CountryDisplay = { country: Scalars['String']['output']; /** * Country tax. - * @deprecated This field will be removed in Saleor 4.0. Always returns `null`. Use `TaxClassCountryRate` type to manage tax rates per country. + * @deprecated Always returns `null`. Use `TaxClassCountryRate` type to manage tax rates per country. */ vat?: Maybe; }; @@ -6253,7 +6370,7 @@ export type CountryRateUpdateInput = { /** Create JWT token. */ export type CreateToken = { __typename?: 'CreateToken'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; /** CSRF token required to re-generate access token. */ csrfToken?: Maybe; @@ -6290,7 +6407,7 @@ export type CreditCard = { */ export type CustomerBulkDelete = { __typename?: 'CustomerBulkDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; /** Returns how many objects were affected. */ count: Scalars['Int']['output']; @@ -6308,10 +6425,6 @@ export type CustomerBulkResult = { /** * Updates customers. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_USERS. * * Triggers the following webhook events: @@ -6337,7 +6450,6 @@ export type CustomerBulkUpdateError = { path?: Maybe; }; -/** An enumeration. */ export type CustomerBulkUpdateErrorCode = | 'BLANK' | 'DUPLICATED_INPUT_ITEM' @@ -6370,17 +6482,13 @@ export type CustomerBulkUpdateInput = { */ export type CustomerCreate = { __typename?: 'CustomerCreate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; user?: Maybe; }; -/** - * Event sent when new customer user is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new customer user is created. */ export type CustomerCreated = Event & { __typename?: 'CustomerCreated'; /** Time of the event. */ @@ -6405,7 +6513,7 @@ export type CustomerCreated = Event & { */ export type CustomerDelete = { __typename?: 'CustomerDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; user?: Maybe; @@ -6434,7 +6542,6 @@ export type CustomerEvent = Node & { user?: Maybe; }; -/** An enumeration. */ export type CustomerEventsEnum = | 'ACCOUNT_ACTIVATED' | 'ACCOUNT_CREATED' @@ -6454,11 +6561,7 @@ export type CustomerEventsEnum = export type CustomerFilterInput = { dateJoined?: InputMaybe; - /** - * Filter by ids. - * - * Added in Saleor 3.8. - */ + /** Filter by ids. */ ids?: InputMaybe>; metadata?: InputMaybe>; numberOfOrders?: InputMaybe; @@ -6474,47 +6577,35 @@ export type CustomerInput = { defaultShippingAddress?: InputMaybe; /** The unique email address of the user. */ email?: InputMaybe; - /** - * External ID of the customer. - * - * Added in Saleor 3.10. - */ + /** External ID of the customer. */ externalReference?: InputMaybe; /** Given name. */ firstName?: InputMaybe; /** User account is active. */ isActive?: InputMaybe; - /** - * User account is confirmed. - * - * Added in Saleor 3.15. - */ + /** User account is confirmed. */ isConfirmed?: InputMaybe; /** User language code. */ languageCode?: InputMaybe; /** Family name. */ lastName?: InputMaybe; /** - * Fields required to update the user metadata. + * Fields required to update the user metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** A note about the user. */ note?: InputMaybe; /** - * Fields required to update the user private metadata. + * Fields required to update the user private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; }; -/** - * Event sent when customer user metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when customer user metadata is updated. */ export type CustomerMetadataUpdated = Event & { __typename?: 'CustomerMetadataUpdated'; /** Time of the event. */ @@ -6540,17 +6631,13 @@ export type CustomerMetadataUpdated = Event & { */ export type CustomerUpdate = { __typename?: 'CustomerUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; user?: Maybe; }; -/** - * Event sent when customer user is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when customer user is updated. */ export type CustomerUpdated = Event & { __typename?: 'CustomerUpdated'; /** Time of the event. */ @@ -6565,6 +6652,34 @@ export type CustomerUpdated = Event & { version?: Maybe; }; +export type CustomerWhereInput = { + /** List of conditions that must be met. */ + AND?: InputMaybe>; + /** A list of conditions of which at least one must be met. */ + OR?: InputMaybe>; + /** Filter by addresses data associated with user. */ + addresses?: InputMaybe; + /** Filter by date joined. */ + dateJoined?: InputMaybe; + /** Filter by email address. */ + email?: InputMaybe; + /** Filter by first name. */ + firstName?: InputMaybe; + ids?: InputMaybe>; + /** Filter by whether the user is active. */ + isActive?: InputMaybe; + /** Filter by last name. */ + lastName?: InputMaybe; + /** Filter by metadata fields. */ + metadata?: InputMaybe; + /** Filter by number of orders placed by the user. */ + numberOfOrders?: InputMaybe; + /** Filter by date when orders were placed. */ + placedOrdersAt?: InputMaybe; + /** Filter by last updated date. */ + updatedAt?: InputMaybe; +}; + export type DateRangeInput = { /** Start date. */ gte?: InputMaybe; @@ -6572,13 +6687,7 @@ export type DateRangeInput = { lte?: InputMaybe; }; -/** - * Define the filtering options for date time fields. - * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Define the filtering options for date time fields. */ export type DateTimeFilterInput = { /** The value equal to. */ eq?: InputMaybe; @@ -6602,18 +6711,12 @@ export type DateTimeRangeInput = { */ export type DeactivateAllUserTokens = { __typename?: 'DeactivateAllUserTokens'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; }; -/** - * Define the filtering options for decimal fields. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Define the filtering options for decimal fields. */ export type DecimalFilterInput = { /** The value equal to. */ eq?: InputMaybe; @@ -6635,7 +6738,7 @@ export type DeleteMetadata = { __typename?: 'DeleteMetadata'; errors: Array; item?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ metadataErrors: Array; }; @@ -6644,15 +6747,11 @@ export type DeletePrivateMetadata = { __typename?: 'DeletePrivateMetadata'; errors: Array; item?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ metadataErrors: Array; }; -/** - * Represents a delivery method chosen for the checkout. `Warehouse` type is used when checkout is marked as "click and collect" and `ShippingMethod` otherwise. - * - * Added in Saleor 3.1. - */ +/** Represents a delivery method chosen for the checkout. `Warehouse` type is used when checkout is marked as "click and collect" and `ShippingMethod` otherwise. */ export type DeliveryMethod = ShippingMethod | Warehouse; /** Represents digital content associated with a product variant. */ @@ -6672,15 +6771,9 @@ export type DigitalContent = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; @@ -6688,15 +6781,9 @@ export type DigitalContent = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** Product variant assigned to digital content. */ productVariant: ProductVariant; @@ -6759,7 +6846,7 @@ export type DigitalContentCreate = { __typename?: 'DigitalContentCreate'; content?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; variant?: Maybe; }; @@ -6772,7 +6859,7 @@ export type DigitalContentCreate = { export type DigitalContentDelete = { __typename?: 'DigitalContentDelete'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; variant?: Maybe; }; @@ -6783,15 +6870,15 @@ export type DigitalContentInput = { /** Determines how many times a download link can be accessed by a customer. */ maxDownloads?: InputMaybe; /** - * Fields required to update the digital content metadata. + * Fields required to update the digital content metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** - * Fields required to update the digital content private metadata. + * Fields required to update the digital content private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** Determines for how many days a download link is active since it was generated. */ @@ -6801,7 +6888,7 @@ export type DigitalContentInput = { }; /** - * Update digital content. + * Updates digital content. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ @@ -6809,7 +6896,7 @@ export type DigitalContentUpdate = { __typename?: 'DigitalContentUpdate'; content?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; variant?: Maybe; }; @@ -6822,15 +6909,15 @@ export type DigitalContentUploadInput = { /** Determines how many times a download link can be accessed by a customer. */ maxDownloads?: InputMaybe; /** - * Fields required to update the digital content metadata. + * Fields required to update the digital content metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** - * Fields required to update the digital content private metadata. + * Fields required to update the digital content private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** Determines for how many days a download link is active since it was generated. */ @@ -6865,7 +6952,7 @@ export type DigitalContentUrlCreate = { __typename?: 'DigitalContentUrlCreate'; digitalContentUrl?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -6894,7 +6981,6 @@ export type DiscountError = { voucherCodes?: Maybe>; }; -/** An enumeration. */ export type DiscountErrorCode = | 'ALREADY_EXISTS' | 'CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT' @@ -6926,7 +7012,6 @@ export type DiscountedObjectWhereInput = { baseTotalPrice?: InputMaybe; }; -/** An enumeration. */ export type DistanceUnitsEnum = | 'CM' | 'DM' @@ -6958,7 +7043,7 @@ export type DraftOrderBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -6972,7 +7057,7 @@ export type DraftOrderComplete = { errors: Array; /** Completed order. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -6985,7 +7070,7 @@ export type DraftOrderCreate = { __typename?: 'DraftOrderCreate'; errors: Array; order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -6996,18 +7081,51 @@ export type DraftOrderCreateInput = { channelId?: InputMaybe; /** A note from a customer. Visible by customers in the order summary. */ customerNote?: InputMaybe; - /** Discount amount for the order. */ + /** + * Discount amount for the order. + * @deprecated Providing a value for the field has no effect. Use `orderDiscountAdd` mutation instead. + */ discount?: InputMaybe; + /** External ID of this order. */ + externalReference?: InputMaybe; /** - * External ID of this order. + * Order language code. * - * Added in Saleor 3.10. + * Added in Saleor 3.21. */ - externalReference?: InputMaybe; + languageCode?: InputMaybe; /** Variant line input consisting of variant ID and quantity of products. */ lines?: InputMaybe>; + /** + * Order public metadata. + * + * Added in Saleor 3.21. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ + metadata?: InputMaybe>; + /** + * Order private metadata. + * + * Added in Saleor 3.21. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ + privateMetadata?: InputMaybe>; /** URL of a view where users should be redirected to see the order details. URL in RFC 1808 format. */ redirectUrl?: InputMaybe; + /** + * Indicates whether the billing address should be saved to the user’s address book upon draft order completion. Can only be set when a billing address is provided. If not specified along with the address, the default behavior is to not save the address. + * + * Added in Saleor 3.21. + */ + saveBillingAddress?: InputMaybe; + /** + * Indicates whether the shipping address should be saved to the user’s address book upon draft order completion.Can only be set when a shipping address is provided. If not specified along with the address, the default behavior is to not save the address. + * + * Added in Saleor 3.21. + */ + saveShippingAddress?: InputMaybe; /** Shipping address of the customer. */ shippingAddress?: InputMaybe; /** ID of a selected shipping method. */ @@ -7026,11 +7144,7 @@ export type DraftOrderCreateInput = { voucherCode?: InputMaybe; }; -/** - * Event sent when new draft order is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new draft order is created. */ export type DraftOrderCreated = Event & { __typename?: 'DraftOrderCreated'; /** Time of the event. */ @@ -7054,15 +7168,11 @@ export type DraftOrderDelete = { __typename?: 'DraftOrderDelete'; errors: Array; order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; -/** - * Event sent when draft order is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when draft order is deleted. */ export type DraftOrderDeleted = Event & { __typename?: 'DraftOrderDeleted'; /** Time of the event. */ @@ -7084,16 +7194,49 @@ export type DraftOrderInput = { channelId?: InputMaybe; /** A note from a customer. Visible by customers in the order summary. */ customerNote?: InputMaybe; - /** Discount amount for the order. */ + /** + * Discount amount for the order. + * @deprecated Providing a value for the field has no effect. Use `orderDiscountAdd` mutation instead. + */ discount?: InputMaybe; + /** External ID of this order. */ + externalReference?: InputMaybe; /** - * External ID of this order. + * Order language code. * - * Added in Saleor 3.10. + * Added in Saleor 3.21. */ - externalReference?: InputMaybe; + languageCode?: InputMaybe; + /** + * Order public metadata. + * + * Added in Saleor 3.21. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ + metadata?: InputMaybe>; + /** + * Order private metadata. + * + * Added in Saleor 3.21. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ + privateMetadata?: InputMaybe>; /** URL of a view where users should be redirected to see the order details. URL in RFC 1808 format. */ redirectUrl?: InputMaybe; + /** + * Indicates whether the billing address should be saved to the user’s address book upon draft order completion. Can only be set when a billing address is provided. If not specified along with the address, the default behavior is to not save the address. + * + * Added in Saleor 3.21. + */ + saveBillingAddress?: InputMaybe; + /** + * Indicates whether the shipping address should be saved to the user’s address book upon draft order completion.Can only be set when a shipping address is provided. If not specified along with the address, the default behavior is to not save the address. + * + * Added in Saleor 3.21. + */ + saveShippingAddress?: InputMaybe; /** Shipping address of the customer. */ shippingAddress?: InputMaybe; /** ID of a selected shipping method. */ @@ -7122,7 +7265,7 @@ export type DraftOrderLinesBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -7135,15 +7278,11 @@ export type DraftOrderUpdate = { __typename?: 'DraftOrderUpdate'; errors: Array; order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; -/** - * Event sent when draft order is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when draft order is updated. */ export type DraftOrderUpdated = Event & { __typename?: 'DraftOrderUpdated'; /** Time of the event. */ @@ -7158,6 +7297,54 @@ export type DraftOrderUpdated = Event & { version?: Maybe; }; +export type DraftOrderWhereInput = { + /** List of conditions that must be met. */ + AND?: InputMaybe>; + /** A list of conditions of which at least one must be met. */ + OR?: InputMaybe>; + /** Filter by authorize status. */ + authorizeStatus?: InputMaybe; + /** Filter by billing address of the order. */ + billingAddress?: InputMaybe; + /** Filter by channel. */ + channelId?: InputMaybe; + /** Filter by charge status. */ + chargeStatus?: InputMaybe; + /** Filter order by created at date. */ + createdAt?: InputMaybe; + /** Filter by order events. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. */ + events?: InputMaybe>; + ids?: InputMaybe>; + /** Filter by whether the order uses the click and collect delivery method. */ + isClickAndCollect?: InputMaybe; + /** Filter by line items associated with the order. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. */ + lines?: InputMaybe>; + /** Filter by number of lines in the order. */ + linesCount?: InputMaybe; + /** Filter by metadata fields. */ + metadata?: InputMaybe; + /** Filter by order number. */ + number?: InputMaybe; + /** Filter by the product type of related order lines. */ + productTypeId?: InputMaybe; + /** Filter by shipping address of the order. */ + shippingAddress?: InputMaybe; + /** Filter by total gross amount of the order. */ + totalGross?: InputMaybe; + /** Filter by total net amount of the order. */ + totalNet?: InputMaybe; + /** Filter by transaction data associated with the order. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. */ + transactions?: InputMaybe>; + /** Filter order by updated at date. */ + updatedAt?: InputMaybe; + /** Filter by user. */ + user?: InputMaybe; + /** Filter by user email. */ + userEmail?: InputMaybe; + /** Filter by voucher code used in the order. */ + voucherCode?: InputMaybe; +}; + export type ErrorPolicyEnum = /** Save what is possible within a single row. If there are errors in an input data row, try to save it partially and skip the invalid part. */ | 'IGNORE_FAILED' @@ -7315,7 +7502,6 @@ export type ExportError = { message?: Maybe; }; -/** An enumeration. */ export type ExportErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' @@ -7339,7 +7525,6 @@ export type ExportEvent = Node & { user?: Maybe; }; -/** An enumeration. */ export type ExportEventsEnum = | 'EXPORTED_FILE_SENT' | 'EXPORT_DELETED' @@ -7412,8 +7597,6 @@ export type ExportFileSortingInput = { /** * Export gift cards to csv file. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -7461,7 +7644,7 @@ export type ExportInfoInput = { export type ExportProducts = { __typename?: 'ExportProducts'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ exportErrors: Array; /** The newly created export file job which is responsible for export data. */ exportFile?: Maybe; @@ -7528,7 +7711,7 @@ export type ExternalAuthentication = { /** Prepare external authentication URL for user by custom plugin. */ export type ExternalAuthenticationUrl = { __typename?: 'ExternalAuthenticationUrl'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; /** The data returned by authentication plugin. */ authenticationData?: Maybe; @@ -7538,7 +7721,7 @@ export type ExternalAuthenticationUrl = { /** Logout user by custom plugin. */ export type ExternalLogout = { __typename?: 'ExternalLogout'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** The data returned by authentication plugin. */ @@ -7555,18 +7738,13 @@ export type ExternalNotificationError = { message?: Maybe; }; -/** An enumeration. */ export type ExternalNotificationErrorCodes = | 'CHANNEL_INACTIVE' | 'INVALID_MODEL_TYPE' | 'NOT_FOUND' | 'REQUIRED'; -/** - * Trigger sending a notification with the notify plugin method. Serializes nodes provided as ids parameter and includes this data in the notification payload. - * - * Added in Saleor 3.1. - */ +/** Trigger sending a notification with the notify plugin method. Serializes nodes provided as ids parameter and includes this data in the notification payload. */ export type ExternalNotificationTrigger = { __typename?: 'ExternalNotificationTrigger'; errors: Array; @@ -7584,7 +7762,7 @@ export type ExternalNotificationTriggerInput = { /** Obtain external access tokens for user by custom plugin. */ export type ExternalObtainAccessTokens = { __typename?: 'ExternalObtainAccessTokens'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; /** CSRF token required to re-generate external access token. */ csrfToken?: Maybe; @@ -7600,7 +7778,7 @@ export type ExternalObtainAccessTokens = { /** Refresh user's access by custom plugin. */ export type ExternalRefresh = { __typename?: 'ExternalRefresh'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; /** CSRF token required to re-generate external access token. */ csrfToken?: Maybe; @@ -7616,7 +7794,7 @@ export type ExternalRefresh = { /** Verify external authentication data by plugin. */ export type ExternalVerify = { __typename?: 'ExternalVerify'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** Determine if authentication data is valid or not. */ @@ -7635,7 +7813,6 @@ export type File = { url: Scalars['String']['output']; }; -/** An enumeration. */ export type FileTypesEnum = | 'CSV' | 'XLSX'; @@ -7648,7 +7825,7 @@ export type FileTypesEnum = export type FileUpload = { __typename?: 'FileUpload'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ uploadErrors: Array; uploadedFile?: Maybe; }; @@ -7670,15 +7847,9 @@ export type Fulfillment = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; @@ -7686,31 +7857,17 @@ export type Fulfillment = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; - /** - * Amount of refunded shipping price. - * - * Added in Saleor 3.14. - */ + /** Amount of refunded shipping price. */ shippingRefundedAmount?: Maybe; /** Status of fulfillment. */ status: FulfillmentStatus; /** User-friendly fulfillment status. */ statusDisplay?: Maybe; - /** - * Total refunded amount assigned to this fulfillment. - * - * Added in Saleor 3.14. - */ + /** Total refunded amount assigned to this fulfillment. */ totalRefundedAmount?: Maybe; /** Fulfillment tracking number. */ trackingNumber: Scalars['String']['output']; @@ -7745,8 +7902,6 @@ export type FulfillmentPrivateMetafieldsArgs = { /** * Approve existing fulfillment. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_ORDERS. * * Triggers the following webhook events: @@ -7759,28 +7914,20 @@ export type FulfillmentApprove = { fulfillment?: Maybe; /** Order which fulfillment was approved. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; -/** - * Event sent when fulfillment is approved. - * - * Added in Saleor 3.7. - */ +/** Event sent when fulfillment is approved. */ export type FulfillmentApproved = Event & { __typename?: 'FulfillmentApproved'; /** The fulfillment the event relates to. */ fulfillment?: Maybe; /** Time of the event. */ issuedAt?: Maybe; - /** The user or application that triggered the event. */ - issuingPrincipal?: Maybe; - /** - * If true, send a notification to the customer. - * - * Added in Saleor 3.16. - */ + /** The user or application that triggered the event. */ + issuingPrincipal?: Maybe; + /** If true, send a notification to the customer. */ notifyCustomer: Scalars['Boolean']['output']; /** The order the fulfillment belongs to. */ order?: Maybe; @@ -7802,7 +7949,7 @@ export type FulfillmentCancel = { fulfillment?: Maybe; /** Order which fulfillment was cancelled. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -7811,11 +7958,7 @@ export type FulfillmentCancelInput = { warehouseId?: InputMaybe; }; -/** - * Event sent when fulfillment is canceled. - * - * Added in Saleor 3.4. - */ +/** Event sent when fulfillment is canceled. */ export type FulfillmentCanceled = Event & { __typename?: 'FulfillmentCanceled'; /** The fulfillment the event relates to. */ @@ -7832,11 +7975,7 @@ export type FulfillmentCanceled = Event & { version?: Maybe; }; -/** - * Event sent when new fulfillment is created. - * - * Added in Saleor 3.4. - */ +/** Event sent when new fulfillment is created. */ export type FulfillmentCreated = Event & { __typename?: 'FulfillmentCreated'; /** The fulfillment the event relates to. */ @@ -7845,11 +7984,7 @@ export type FulfillmentCreated = Event & { issuedAt?: Maybe; /** The user or application that triggered the event. */ issuingPrincipal?: Maybe; - /** - * If true, the app should send a notification to the customer. - * - * Added in Saleor 3.16. - */ + /** If true, the app should send a notification to the customer. */ notifyCustomer: Scalars['Boolean']['output']; /** The order the fulfillment belongs to. */ order?: Maybe; @@ -7859,6 +7994,16 @@ export type FulfillmentCreated = Event & { version?: Maybe; }; +/** Filter input for order fulfillments data. */ +export type FulfillmentFilterInput = { + /** Filter by metadata fields. */ + metadata?: InputMaybe; + /** Filter by fulfillment status. */ + status?: InputMaybe; + /** Filter by fulfillment warehouse. */ + warehouse?: InputMaybe; +}; + /** Represents line of the fulfillment. */ export type FulfillmentLine = Node & { __typename?: 'FulfillmentLine'; @@ -7870,11 +8015,7 @@ export type FulfillmentLine = Node & { quantity: Scalars['Int']['output']; }; -/** - * Event sent when fulfillment metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when fulfillment metadata is updated. */ export type FulfillmentMetadataUpdated = Event & { __typename?: 'FulfillmentMetadataUpdated'; /** The fulfillment the event relates to. */ @@ -7903,7 +8044,7 @@ export type FulfillmentRefundProducts = { fulfillment?: Maybe; /** Order which fulfillment was refunded. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -7917,7 +8058,7 @@ export type FulfillmentReturnProducts = { errors: Array; /** Order which fulfillment was returned. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; /** A replace fulfillment. */ replaceFulfillment?: Maybe; @@ -7927,7 +8068,6 @@ export type FulfillmentReturnProducts = { returnFulfillment?: Maybe; }; -/** An enumeration. */ export type FulfillmentStatus = | 'CANCELED' | 'FULFILLED' @@ -7937,11 +8077,15 @@ export type FulfillmentStatus = | 'RETURNED' | 'WAITING_FOR_APPROVAL'; -/** - * Event sent when the tracking number is updated. - * - * Added in Saleor 3.16. - */ +/** Filter by fulfillment status. */ +export type FulfillmentStatusEnumFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value included in. */ + oneOf?: InputMaybe>; +}; + +/** Event sent when the tracking number is updated. */ export type FulfillmentTrackingNumberUpdated = Event & { __typename?: 'FulfillmentTrackingNumberUpdated'; /** The fulfillment the event relates to. */ @@ -7973,7 +8117,7 @@ export type FulfillmentUpdateTracking = { fulfillment?: Maybe; /** Order for which fulfillment was updated. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -7984,6 +8128,16 @@ export type FulfillmentUpdateTrackingInput = { trackingNumber?: InputMaybe; }; +/** Filter input for fulfillment warehouses. */ +export type FulfillmentWarehouseFilterInput = { + /** Filter fulfillments by warehouse external reference. */ + externalReference?: InputMaybe; + /** Filter fulfillments by warehouse ID. */ + id?: InputMaybe; + /** Filter fulfillments by warehouse slug. */ + slug?: InputMaybe; +}; + /** Payment gateway client configuration key and value pair. */ export type GatewayConfigLine = { __typename?: 'GatewayConfigLine'; @@ -7999,16 +8153,10 @@ export type GiftCard = Node & ObjectWithMetadata & { /** * App which created the gift card. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_APPS, OWNER. */ app?: Maybe; - /** - * Slug of the channel where the gift card was bought. - * - * Added in Saleor 3.1. - */ + /** Slug of the channel where the gift card was bought. */ boughtInChannel?: Maybe; /** * 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. @@ -8018,17 +8166,11 @@ export type GiftCard = Node & ObjectWithMetadata & { code: Scalars['String']['output']; /** Date and time when gift card was created. */ created: Scalars['DateTime']['output']; - /** - * The user who bought or issued a gift card. - * - * Added in Saleor 3.1. - */ + /** The user who bought or issued a gift card. */ createdBy?: Maybe; /** * Email address of the user who bought or issued gift card. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_USERS, OWNER. */ createdByEmail?: Maybe; @@ -8037,14 +8179,12 @@ export type GiftCard = Node & ObjectWithMetadata & { displayCode: Scalars['String']['output']; /** * End date of gift card. - * @deprecated This field will be removed in Saleor 4.0. Use `expiryDate` field instead. + * @deprecated Use `expiryDate` field instead. */ endDate?: Maybe; /** * List of events associated with the gift card. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. */ events: Array; @@ -8064,15 +8204,9 @@ export type GiftCard = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; @@ -8080,52 +8214,36 @@ export type GiftCard = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; - /** - * Related gift card product. - * - * Added in Saleor 3.1. - */ + /** Related gift card product. */ product?: Maybe; /** * Start date of gift card. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ startDate?: Maybe; /** * The gift card tag. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. */ tags: Array; /** * The customer who used a gift card. - * - * Added in Saleor 3.1. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ usedBy?: Maybe; /** * Email address of the customer who used a gift card. - * - * Added in Saleor 3.1. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ usedByEmail?: Maybe; /** * The customer who bought a gift card. - * @deprecated This field will be removed in Saleor 4.0. Use `createdBy` field instead. + * @deprecated Use `createdBy` field instead. */ user?: Maybe; }; @@ -8173,15 +8291,13 @@ export type GiftCardActivate = { errors: Array; /** Activated gift card. */ giftCard?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ giftCardErrors: Array; }; /** * Adds note to the gift card. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -8204,8 +8320,6 @@ export type GiftCardAddNoteInput = { /** * Activate gift cards. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -8219,9 +8333,7 @@ export type GiftCardBulkActivate = { }; /** - * Create gift cards. - * - * Added in Saleor 3.1. + * Creates gift cards. * * Requires one of the following permissions: MANAGE_GIFT_CARD. * @@ -8254,8 +8366,6 @@ export type GiftCardBulkCreateInput = { /** * Deactivate gift cards. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -8269,9 +8379,7 @@ export type GiftCardBulkDeactivate = { }; /** - * Delete gift cards. - * - * Added in Saleor 3.1. + * Deletes gift cards. * * Requires one of the following permissions: MANAGE_GIFT_CARD. * @@ -8315,70 +8423,59 @@ export type GiftCardCreate = { __typename?: 'GiftCardCreate'; errors: Array; giftCard?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ giftCardErrors: Array; }; export type GiftCardCreateInput = { - /** - * The gift card tags to add. - * - * Added in Saleor 3.1. - */ + /** The gift card tags to add. */ addTags?: InputMaybe>; /** Balance of the gift card. */ balance: PriceInput; - /** - * Slug of a channel from which the email should be sent. - * - * Added in Saleor 3.1. - */ + /** Slug of a channel from which the email should be sent. */ channel?: InputMaybe; /** * Code to use the gift card. - * - * DEPRECATED: this field will be removed in Saleor 4.0. The code is now auto generated. + * @deprecated The code is now auto generated. */ code?: InputMaybe; /** * End date of the gift card in ISO 8601 format. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `expiryDate` from `expirySettings` instead. + * @deprecated Use `expiryDate` from `expirySettings` instead. */ endDate?: InputMaybe; - /** - * The gift card expiry date. - * - * Added in Saleor 3.1. - */ + /** The gift card expiry date. */ expiryDate?: InputMaybe; + /** Determine if gift card is active. */ + isActive: Scalars['Boolean']['input']; /** - * Determine if gift card is active. + * Gift Card public metadata. + * + * Added in Saleor 3.21. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.1. + * Warning: never store sensitive information, including financial data such as credit card details. */ - isActive: Scalars['Boolean']['input']; + metadata?: InputMaybe>; + /** The gift card note from the staff member. */ + note?: InputMaybe; /** - * The gift card note from the staff member. + * Gift Card private metadata. + * + * Added in Saleor 3.21. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.1. + * Warning: never store sensitive information, including financial data such as credit card details. */ - note?: InputMaybe; + privateMetadata?: InputMaybe>; /** * Start date of the gift card in ISO 8601 format. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ startDate?: InputMaybe; /** Email of the customer to whom gift card will be sent. */ userEmail?: InputMaybe; }; -/** - * Event sent when new gift card is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new gift card is created. */ export type GiftCardCreated = Event & { __typename?: 'GiftCardCreated'; /** The gift card the event relates to. */ @@ -8406,14 +8503,12 @@ export type GiftCardDeactivate = { errors: Array; /** Deactivated gift card. */ giftCard?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ giftCardErrors: Array; }; /** - * Delete gift card. - * - * Added in Saleor 3.1. + * Deletes gift card. * * Requires one of the following permissions: MANAGE_GIFT_CARD. * @@ -8424,15 +8519,11 @@ export type GiftCardDelete = { __typename?: 'GiftCardDelete'; errors: Array; giftCard?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ giftCardErrors: Array; }; -/** - * Event sent when gift card is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when gift card is deleted. */ export type GiftCardDeleted = Event & { __typename?: 'GiftCardDeleted'; /** The gift card the event relates to. */ @@ -8459,7 +8550,6 @@ export type GiftCardError = { tags?: Maybe>; }; -/** An enumeration. */ export type GiftCardErrorCode = | 'ALREADY_EXISTS' | 'DUPLICATED_INPUT_ITEM' @@ -8470,11 +8560,7 @@ export type GiftCardErrorCode = | 'REQUIRED' | 'UNIQUE'; -/** - * History log of the gift card. - * - * Added in Saleor 3.1. - */ +/** History log of the gift card. */ export type GiftCardEvent = Node & { __typename?: 'GiftCardEvent'; /** App that performed the action. Requires one of the following permissions: MANAGE_APPS, OWNER. */ @@ -8524,7 +8610,6 @@ export type GiftCardEventFilterInput = { type?: InputMaybe; }; -/** An enumeration. */ export type GiftCardEventsEnum = | 'ACTIVATED' | 'BALANCE_RESET' @@ -8539,11 +8624,7 @@ export type GiftCardEventsEnum = | 'UPDATED' | 'USED_IN_ORDER'; -/** - * Event sent when gift card export is completed. - * - * Added in Saleor 3.16. - */ +/** Event sent when gift card export is completed. */ export type GiftCardExportCompleted = Event & { __typename?: 'GiftCardExportCompleted'; /** The export file for gift cards. */ @@ -8572,11 +8653,7 @@ export type GiftCardFilterInput = { usedBy?: InputMaybe>; }; -/** - * Event sent when gift card metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when gift card metadata is updated. */ export type GiftCardMetadataUpdated = Event & { __typename?: 'GiftCardMetadataUpdated'; /** The gift card the event relates to. */ @@ -8594,8 +8671,6 @@ export type GiftCardMetadataUpdated = Event & { /** * Resend a gift card. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -8617,13 +8692,7 @@ export type GiftCardResendInput = { id: Scalars['ID']['input']; }; -/** - * Event sent when gift card is e-mailed. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when gift card is e-mailed. */ export type GiftCardSent = Event & { __typename?: 'GiftCardSent'; /** Slug of a channel for which this gift card email was sent. */ @@ -8661,13 +8730,11 @@ export type GiftCardSettingsError = { message?: Maybe; }; -/** An enumeration. */ export type GiftCardSettingsErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' | 'REQUIRED'; -/** An enumeration. */ export type GiftCardSettingsExpiryTypeEnum = | 'EXPIRY_PERIOD' | 'NEVER_EXPIRE'; @@ -8692,11 +8759,7 @@ export type GiftCardSettingsUpdateInput = { }; export type GiftCardSortField = - /** - * Sort gift cards by created at. - * - * Added in Saleor 3.8. - */ + /** Sort gift cards by created at. */ | 'CREATED_AT' /** Sort gift cards by current balance. */ | 'CURRENT_BALANCE' @@ -8712,11 +8775,7 @@ export type GiftCardSortingInput = { field: GiftCardSortField; }; -/** - * Event sent when gift card status has changed. - * - * Added in Saleor 3.2. - */ +/** Event sent when gift card status has changed. */ export type GiftCardStatusChanged = Event & { __typename?: 'GiftCardStatusChanged'; /** The gift card the event relates to. */ @@ -8731,11 +8790,7 @@ export type GiftCardStatusChanged = Event & { version?: Maybe; }; -/** - * The gift card tag. - * - * Added in Saleor 3.1. - */ +/** The gift card tag. */ export type GiftCardTag = Node & { __typename?: 'GiftCardTag'; /** ID of the tag associated with a gift card. */ @@ -8777,54 +8832,48 @@ export type GiftCardUpdate = { __typename?: 'GiftCardUpdate'; errors: Array; giftCard?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ giftCardErrors: Array; }; export type GiftCardUpdateInput = { - /** - * The gift card tags to add. - * - * Added in Saleor 3.1. - */ + /** The gift card tags to add. */ addTags?: InputMaybe>; - /** - * The gift card balance amount. - * - * Added in Saleor 3.1. - */ + /** The gift card balance amount. */ balanceAmount?: InputMaybe; /** * End date of the gift card in ISO 8601 format. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `expiryDate` from `expirySettings` instead. + * @deprecated Use `expiryDate` from `expirySettings` instead. */ endDate?: InputMaybe; + /** The gift card expiry date. */ + expiryDate?: InputMaybe; /** - * The gift card expiry date. + * Gift Card public metadata. + * + * Added in Saleor 3.21. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.1. + * Warning: never store sensitive information, including financial data such as credit card details. */ - expiryDate?: InputMaybe; + metadata?: InputMaybe>; /** - * The gift card tags to remove. + * Gift Card private metadata. * - * Added in Saleor 3.1. + * Added in Saleor 3.21. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. */ + privateMetadata?: InputMaybe>; + /** The gift card tags to remove. */ removeTags?: InputMaybe>; /** * Start date of the gift card in ISO 8601 format. - * - * DEPRECATED: this field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ startDate?: InputMaybe; }; -/** - * Event sent when gift card is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when gift card is updated. */ export type GiftCardUpdated = Event & { __typename?: 'GiftCardUpdated'; /** The gift card the event relates to. */ @@ -8839,13 +8888,7 @@ export type GiftCardUpdated = Event & { version?: Maybe; }; -/** - * Define the filtering options for foreign key fields. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Define the filtering options for foreign key fields. */ export type GlobalIdFilterInput = { /** The value equal to. */ eq?: InputMaybe; @@ -8856,13 +8899,7 @@ export type GlobalIdFilterInput = { /** Represents permission group data. */ export type Group = Node & { __typename?: 'Group'; - /** - * List of channels the group has access to. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of channels the group has access to. */ accessibleChannels?: Maybe>; /** The ID of the group. */ id: Scalars['ID']['output']; @@ -8870,13 +8907,7 @@ export type Group = Node & { name: Scalars['String']['output']; /** List of group permissions */ permissions?: Maybe>; - /** - * Determine if the group have restricted access to channels. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Determine if the group have restricted access to channels. */ restrictedAccessToChannels: Scalars['Boolean']['output']; /** True, if the currently authenticated user has rights to manage a group. */ userCanManage: Scalars['Boolean']['output']; @@ -8905,6 +8936,10 @@ export type GroupCountableEdge = { node: Group; }; +export type HttpMethod = + | 'GET' + | 'POST'; + /** Thumbnail formats for icon images. */ export type IconThumbnailFormatEnum = | 'ORIGINAL' @@ -8919,6 +8954,16 @@ export type Image = { url: Scalars['String']['output']; }; +/** Define the filtering options for integer fields. */ +export type IntFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value included in. */ + oneOf?: InputMaybe>; + /** The value in range. */ + range?: InputMaybe; +}; + export type IntRangeInput = { /** Value greater than or equal to. */ gte?: InputMaybe; @@ -8933,7 +8978,7 @@ export type Invoice = Job & Node & ObjectWithMetadata & { createdAt: Scalars['DateTime']['output']; /** * URL to view an invoice. - * @deprecated This field will be removed in Saleor 4.0. Use `url` field.This field will be removed in 4.0 + * @deprecated Use `url` field. */ externalUrl?: Maybe; /** The ID of the object. */ @@ -8946,23 +8991,13 @@ export type Invoice = Job & Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Invoice number. */ number?: Maybe; - /** - * Order related to the invoice. - * - * Added in Saleor 3.10. - */ + /** Order related to the invoice. */ order?: Maybe; /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; @@ -8970,21 +9005,15 @@ export type Invoice = Job & Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** Job status. */ status: JobStatusEnum; /** Date and time at which invoice was updated. */ updatedAt: Scalars['DateTime']['output']; - /** URL to view/download an invoice. This can be an internal URL if the Invoicing Plugin was used or an external URL if it has been provided. */ + /** URL to view/download an invoice. */ url?: Maybe; }; @@ -9021,23 +9050,23 @@ export type InvoiceCreate = { __typename?: 'InvoiceCreate'; errors: Array; invoice?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ invoiceErrors: Array; }; export type InvoiceCreateInput = { /** - * Fields required to update the invoice metadata. + * Fields required to update the invoice metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Invoice number. */ number: Scalars['String']['input']; /** - * Fields required to update the invoice private metadata. + * Fields required to update the invoice private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** URL of an invoice to download. */ @@ -9053,15 +9082,11 @@ export type InvoiceDelete = { __typename?: 'InvoiceDelete'; errors: Array; invoice?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ invoiceErrors: Array; }; -/** - * Event sent when invoice is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when invoice is deleted. */ export type InvoiceDeleted = Event & { __typename?: 'InvoiceDeleted'; /** The invoice the event relates to. */ @@ -9070,11 +9095,7 @@ export type InvoiceDeleted = Event & { issuedAt?: Maybe; /** The user or application that triggered the event. */ issuingPrincipal?: Maybe; - /** - * Order related to the invoice. - * - * Added in Saleor 3.10. - */ + /** Order related to the invoice. */ order?: Maybe; /** The application receiving the webhook. */ recipient?: Maybe; @@ -9092,7 +9113,6 @@ export type InvoiceError = { message?: Maybe; }; -/** An enumeration. */ export type InvoiceErrorCode = | 'EMAIL_NOT_SET' | 'INVALID_STATUS' @@ -9103,6 +9123,12 @@ export type InvoiceErrorCode = | 'REQUIRED' | 'URL_NOT_SET'; +/** Filter input for invoices. */ +export type InvoiceFilterInput = { + /** Filter invoices by creation date. */ + createdAt?: InputMaybe; +}; + /** * Request an invoice for the order using plugin. * @@ -9115,7 +9141,7 @@ export type InvoiceRequest = { __typename?: 'InvoiceRequest'; errors: Array; invoice?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ invoiceErrors: Array; /** Order related to an invoice. */ order?: Maybe; @@ -9133,15 +9159,11 @@ export type InvoiceRequestDelete = { __typename?: 'InvoiceRequestDelete'; errors: Array; invoice?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ invoiceErrors: Array; }; -/** - * Event sent when invoice is requested. - * - * Added in Saleor 3.2. - */ +/** Event sent when invoice is requested. */ export type InvoiceRequested = Event & { __typename?: 'InvoiceRequested'; /** The invoice the event relates to. */ @@ -9150,11 +9172,7 @@ export type InvoiceRequested = Event & { issuedAt?: Maybe; /** The user or application that triggered the event. */ issuingPrincipal?: Maybe; - /** - * Order related to the invoice. - * - * Added in Saleor 3.10. - */ + /** Order related to the invoice. */ order: Order; /** The application receiving the webhook. */ recipient?: Maybe; @@ -9175,15 +9193,11 @@ export type InvoiceSendNotification = { __typename?: 'InvoiceSendNotification'; errors: Array; invoice?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ invoiceErrors: Array; }; -/** - * Event sent when invoice is sent. - * - * Added in Saleor 3.2. - */ +/** Event sent when invoice is sent. */ export type InvoiceSent = Event & { __typename?: 'InvoiceSent'; /** The invoice the event relates to. */ @@ -9192,11 +9206,7 @@ export type InvoiceSent = Event & { issuedAt?: Maybe; /** The user or application that triggered the event. */ issuingPrincipal?: Maybe; - /** - * Order related to the invoice. - * - * Added in Saleor 3.10. - */ + /** Order related to the invoice. */ order?: Maybe; /** The application receiving the webhook. */ recipient?: Maybe; @@ -9213,7 +9223,7 @@ export type InvoiceUpdate = { __typename?: 'InvoiceUpdate'; errors: Array; invoice?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ invoiceErrors: Array; }; @@ -9230,14 +9240,12 @@ export type Job = { updatedAt: Scalars['DateTime']['output']; }; -/** An enumeration. */ export type JobStatusEnum = | 'DELETED' | 'FAILED' | 'PENDING' | 'SUCCESS'; -/** An enumeration. */ export type LanguageCodeEnum = | 'AF' | 'AF_NA' @@ -10050,11 +10058,15 @@ export type Limits = { warehouses?: Maybe; }; +/** Filter input for order lines data. */ +export type LinesFilterInput = { + /** Filter by metadata fields of order lines. */ + metadata?: InputMaybe; +}; + /** * List payment methods stored for the user by payment gateway. * - * Added in Saleor 3.15. - * * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ export type ListStoredPaymentMethods = Event & { @@ -10080,41 +10092,25 @@ export type Manifest = { about?: Maybe; /** App website rendered in the dashboard. */ appUrl?: Maybe; - /** - * The audience that will be included in all JWT tokens for the app. - * - * Added in Saleor 3.8. - */ + /** The audience that will be included in all JWT tokens for the app. */ audience?: Maybe; - /** - * The App's author name. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The App's author name. */ author?: Maybe; - /** - * App's brand data. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** App's brand data. */ brand?: Maybe; /** * URL to iframe with the configuration for the app. - * @deprecated This field will be removed in Saleor 4.0. Use `appUrl` instead. + * @deprecated Use `appUrl` instead. */ configurationUrl?: Maybe; /** * Description of the data privacy defined for this app. - * @deprecated This field will be removed in Saleor 4.0. Use `dataPrivacyUrl` instead. + * @deprecated Use `dataPrivacyUrl` instead. */ dataPrivacy?: Maybe; /** URL to the full privacy policy. */ dataPrivacyUrl?: Maybe; - /** List of extensions that will be mounted in Saleor's dashboard. For details, please [see the extension section.](https://docs.saleor.io/docs/3.x/developer/extending/apps/extending-dashboard-with-apps#key-concepts) */ + /** List of extensions that will be mounted in Saleor's dashboard. For details, please [see the extension section.](https://docs.saleor.io/developer/extending/apps/extending-dashboard-with-apps#key-concepts) */ extensions: Array; /** External URL to the app homepage. */ homepageUrl?: Maybe; @@ -10124,25 +10120,15 @@ export type Manifest = { name: Scalars['String']['output']; /** The array permissions required for the app. */ permissions?: Maybe>; - /** - * Determines the app's required Saleor version as semver range. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Determines the app's required Saleor version as semver range. */ requiredSaleorVersion?: Maybe; /** External URL to the page where app users can find support. */ supportUrl?: Maybe; - /** Endpoint used during process of app installation, [see installing an app.](https://docs.saleor.io/docs/3.x/developer/extending/apps/installing-apps#installing-an-app) */ + /** Endpoint used during process of app installation, [see installing an app.](https://docs.saleor.io/developer/extending/apps/installing-apps#installing-an-app) */ tokenTargetUrl?: Maybe; /** The version of the manifest for the app. */ version: Scalars['String']['output']; - /** - * List of the app's webhooks. - * - * Added in Saleor 3.5. - */ + /** List of the app's webhooks. */ webhooks: Array; }; @@ -10168,7 +10154,6 @@ export type MarkAsPaidStrategyEnum = | 'PAYMENT_FLOW' | 'TRANSACTION_FLOW'; -/** An enumeration. */ export type MeasurementUnitsEnum = | 'ACRE_FT' | 'ACRE_IN' @@ -10245,15 +10230,9 @@ export type Menu = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** The name of the menu. */ name: Scalars['String']['output']; @@ -10263,15 +10242,9 @@ export type Menu = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** Slug of the menu. */ slug: Scalars['String']['output']; @@ -10314,7 +10287,7 @@ export type MenuBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; }; @@ -10347,7 +10320,7 @@ export type MenuCreate = { __typename?: 'MenuCreate'; errors: Array; menu?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; }; @@ -10360,11 +10333,7 @@ export type MenuCreateInput = { slug?: InputMaybe; }; -/** - * Event sent when new menu is created. - * - * Added in Saleor 3.4. - */ +/** Event sent when new menu is created. */ export type MenuCreated = Event & { __typename?: 'MenuCreated'; /** Time of the event. */ @@ -10380,11 +10349,7 @@ export type MenuCreated = Event & { }; -/** - * Event sent when new menu is created. - * - * Added in Saleor 3.4. - */ +/** Event sent when new menu is created. */ export type MenuCreatedMenuArgs = { channel?: InputMaybe; }; @@ -10401,15 +10366,11 @@ export type MenuDelete = { __typename?: 'MenuDelete'; errors: Array; menu?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; }; -/** - * Event sent when menu is deleted. - * - * Added in Saleor 3.4. - */ +/** Event sent when menu is deleted. */ export type MenuDeleted = Event & { __typename?: 'MenuDeleted'; /** Time of the event. */ @@ -10425,11 +10386,7 @@ export type MenuDeleted = Event & { }; -/** - * Event sent when menu is deleted. - * - * Added in Saleor 3.4. - */ +/** Event sent when menu is deleted. */ export type MenuDeletedMenuArgs = { channel?: InputMaybe; }; @@ -10444,7 +10401,6 @@ export type MenuError = { message?: Maybe; }; -/** An enumeration. */ export type MenuErrorCode = | 'CANNOT_ASSIGN_NODE' | 'GRAPHQL_ERROR' @@ -10491,15 +10447,9 @@ export type MenuItem = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** The name of the menu item. */ name: Scalars['String']['output']; @@ -10513,15 +10463,9 @@ export type MenuItem = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** Returns translated menu item fields for the given language code. */ translation?: Maybe; @@ -10572,7 +10516,7 @@ export type MenuItemBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; }; @@ -10604,7 +10548,7 @@ export type MenuItemCountableEdge = { export type MenuItemCreate = { __typename?: 'MenuItemCreate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; menuItem?: Maybe; }; @@ -10626,11 +10570,7 @@ export type MenuItemCreateInput = { url?: InputMaybe; }; -/** - * Event sent when new menu item is created. - * - * Added in Saleor 3.4. - */ +/** Event sent when new menu item is created. */ export type MenuItemCreated = Event & { __typename?: 'MenuItemCreated'; /** Time of the event. */ @@ -10646,11 +10586,7 @@ export type MenuItemCreated = Event & { }; -/** - * Event sent when new menu item is created. - * - * Added in Saleor 3.4. - */ +/** Event sent when new menu item is created. */ export type MenuItemCreatedMenuItemArgs = { channel?: InputMaybe; }; @@ -10666,16 +10602,12 @@ export type MenuItemCreatedMenuItemArgs = { export type MenuItemDelete = { __typename?: 'MenuItemDelete'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; menuItem?: Maybe; }; -/** - * Event sent when menu item is deleted. - * - * Added in Saleor 3.4. - */ +/** Event sent when menu item is deleted. */ export type MenuItemDeleted = Event & { __typename?: 'MenuItemDeleted'; /** Time of the event. */ @@ -10691,11 +10623,7 @@ export type MenuItemDeleted = Event & { }; -/** - * Event sent when menu item is deleted. - * - * Added in Saleor 3.4. - */ +/** Event sent when menu item is deleted. */ export type MenuItemDeletedMenuItemArgs = { channel?: InputMaybe; }; @@ -10731,7 +10659,7 @@ export type MenuItemMove = { errors: Array; /** Assigned menu to move within. */ menu?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; }; @@ -10757,15 +10685,11 @@ export type MenuItemTranslatableContent = Node & { /** The ID of the menu item translatable content. */ id: Scalars['ID']['output']; /** - * Represents a single item of the related menu. Can store categories, collection or pages. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. - */ - menuItem?: Maybe; - /** - * The ID of the menu item to translate. - * - * Added in Saleor 3.14. + * Represents a single item of the related menu. Can store categories, collection or pages. + * @deprecated Get model fields from the root level queries. */ + menuItem?: Maybe; + /** The ID of the menu item to translate. */ menuItemId: Scalars['ID']['output']; /** Name of the menu item to translate. */ name: Scalars['String']['output']; @@ -10788,7 +10712,7 @@ export type MenuItemTranslate = { __typename?: 'MenuItemTranslate'; errors: Array; menuItem?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; @@ -10801,11 +10725,7 @@ export type MenuItemTranslation = Node & { language: LanguageDisplay; /** Translated menu item name. */ name: Scalars['String']['output']; - /** - * Represents the menu item fields to translate. - * - * Added in Saleor 3.14. - */ + /** Represents the menu item fields to translate. */ translatableContent?: Maybe; }; @@ -10820,16 +10740,12 @@ export type MenuItemTranslation = Node & { export type MenuItemUpdate = { __typename?: 'MenuItemUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; menuItem?: Maybe; }; -/** - * Event sent when menu item is updated. - * - * Added in Saleor 3.4. - */ +/** Event sent when menu item is updated. */ export type MenuItemUpdated = Event & { __typename?: 'MenuItemUpdated'; /** Time of the event. */ @@ -10845,11 +10761,7 @@ export type MenuItemUpdated = Event & { }; -/** - * Event sent when menu item is updated. - * - * Added in Saleor 3.4. - */ +/** Event sent when menu item is updated. */ export type MenuItemUpdatedMenuItemArgs = { channel?: InputMaybe; }; @@ -10883,15 +10795,11 @@ export type MenuUpdate = { __typename?: 'MenuUpdate'; errors: Array; menu?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ menuErrors: Array; }; -/** - * Event sent when menu is updated. - * - * Added in Saleor 3.4. - */ +/** Event sent when menu is updated. */ export type MenuUpdated = Event & { __typename?: 'MenuUpdated'; /** Time of the event. */ @@ -10907,11 +10815,7 @@ export type MenuUpdated = Event & { }; -/** - * Event sent when menu is updated. - * - * Added in Saleor 3.4. - */ +/** Event sent when menu is updated. */ export type MenuUpdatedMenuArgs = { channel?: InputMaybe; }; @@ -10926,7 +10830,6 @@ export type MetadataError = { message?: Maybe; }; -/** An enumeration. */ export type MetadataErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' @@ -10941,6 +10844,24 @@ export type MetadataFilter = { value?: InputMaybe; }; +/** + * 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". + */ +export type MetadataFilterInput = { + /** Key to filter by. If not other fields provided - checking the existence of the key in metadata. */ + key: Scalars['String']['input']; + /** Value to filter by. */ + value?: InputMaybe; +}; + export type MetadataInput = { /** Key of a metadata item. */ key: Scalars['String']['input']; @@ -10956,6 +10877,14 @@ export type MetadataItem = { value: Scalars['String']['output']; }; +/** Define the filtering options for metadata value fields. */ +export type MetadataValueFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value included in. */ + oneOf?: InputMaybe>; +}; + /** Represents amount of money in specific currency. */ export type Money = { __typename?: 'Money'; @@ -10963,6 +10892,10 @@ export type Money = { amount: Scalars['Float']['output']; /** Currency code. */ currency: Scalars['String']['output']; + /** Number of digits after the decimal point in the currency. */ + fractionDigits: Scalars['Int']['output']; + /** Amount of money represented as an integer in the smallest currency unit. */ + fractionalAmount: Scalars['Int']['output']; }; export type MoneyInput = { @@ -11001,7 +10934,7 @@ export type Mutation = { */ accountAddressCreate?: Maybe; /** - * Delete an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER. + * Deletes an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER. * * Triggers the following webhook events: * - ADDRESS_DELETED (async): An address was deleted. @@ -11132,7 +11065,7 @@ export type Mutation = { */ appDelete?: Maybe; /** - * Delete failed installation. + * Deletes failed installation. * * Requires one of the following permissions: MANAGE_APPS. */ @@ -11145,6 +11078,14 @@ export type Mutation = { appFetchManifest?: Maybe; /** Install new app by using app manifest. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS. */ appInstall?: 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. + * + * Added in Saleor 3.21. + * + * Requires one of the following permissions: MANAGE_APPS. + */ + appReenableSyncWebhooks?: Maybe; /** * Retry failed installation of new app. * @@ -11192,10 +11133,6 @@ export type Mutation = { /** * Creates attributes. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Triggers the following webhook events: * - ATTRIBUTE_CREATED (async): An attribute was created. */ @@ -11212,20 +11149,12 @@ export type Mutation = { /** * Creates/updates translations for attributes. * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. */ attributeBulkTranslate?: Maybe; /** * Updates attributes. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Triggers the following webhook events: * - ATTRIBUTE_UPDATED (async): An attribute was updated. Optionally called when new attribute value was created or deleted. * - ATTRIBUTE_VALUE_CREATED (async): Called optionally when an attribute value was created. @@ -11284,11 +11213,7 @@ export type Mutation = { */ attributeValueBulkDelete?: Maybe; /** - * Creates/updates translations for attributes values. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Creates/updates translations for attribute values. * * Requires one of the following permissions: MANAGE_TRANSLATIONS. */ @@ -11369,7 +11294,7 @@ export type Mutation = { */ channelActivate?: Maybe; /** - * Creates new channel. + * Creates a new channel. * * Requires one of the following permissions: MANAGE_CHANNELS. * @@ -11387,7 +11312,7 @@ export type Mutation = { */ channelDeactivate?: Maybe; /** - * Delete a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. + * Deletes a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. * * Requires one of the following permissions: MANAGE_CHANNELS. * @@ -11398,8 +11323,6 @@ export type Mutation = { /** * Reorder the warehouses of a channel. * - * Added in Saleor 3.7. - * * Requires one of the following permissions: MANAGE_CHANNELS. */ channelReorderWarehouses?: Maybe; @@ -11424,7 +11347,7 @@ export type Mutation = { */ checkoutAddPromoCode?: Maybe; /** - * Update billing address in the existing checkout. + * Updates billing address in the existing checkout. * * Triggers the following webhook events: * - CHECKOUT_UPDATED (async): A checkout was updated. @@ -11455,13 +11378,7 @@ export type Mutation = { * - CHECKOUT_CREATED (async): A checkout was created. */ checkoutCreate?: Maybe; - /** - * Create new checkout from existing order. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Creates a new checkout from existing order. */ checkoutCreateFromOrder?: Maybe; /** * Sets the customer as the owner of the checkout. @@ -11482,9 +11399,16 @@ export type Mutation = { */ checkoutCustomerDetach?: Maybe; /** - * 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. + * Updates customer note in the existing checkout object. + * + * Added in Saleor 3.21. * - * Added in Saleor 3.1. + * Triggers the following webhook events: + * - CHECKOUT_UPDATED (async): A checkout was updated. + */ + checkoutCustomerNoteUpdate?: Maybe; + /** + * 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. * * Triggers the following webhook events: * - SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Triggered when updating the checkout delivery method with the external one. @@ -11499,7 +11423,7 @@ export type Mutation = { */ checkoutEmailUpdate?: Maybe; /** - * Update language code in the existing checkout. + * Updates language code in the existing checkout. * * Triggers the following webhook events: * - CHECKOUT_UPDATED (async): A checkout was updated. @@ -11510,7 +11434,7 @@ export type Mutation = { * * Triggers the following webhook events: * - CHECKOUT_UPDATED (async): A checkout was updated. - * @deprecated This field will be removed in Saleor 4.0. Use `checkoutLinesDelete` instead. + * @deprecated Use `checkoutLinesDelete` instead. */ checkoutLineDelete?: Maybe; /** @@ -11534,7 +11458,7 @@ export type Mutation = { * - CHECKOUT_UPDATED (async): A checkout was updated. */ checkoutLinesUpdate?: Maybe; - /** Create a new payment for given checkout. */ + /** Creates a new payment for given checkout. */ checkoutPaymentCreate?: Maybe; /** * Remove a gift card or a voucher from a checkout. @@ -11544,7 +11468,7 @@ export type Mutation = { */ checkoutRemovePromoCode?: Maybe; /** - * Update shipping address in the existing checkout. + * Updates shipping address in the existing checkout. * * Triggers the following webhook events: * - CHECKOUT_UPDATED (async): A checkout was updated. @@ -11556,7 +11480,7 @@ export type Mutation = { * 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. - * @deprecated This field will be removed in Saleor 4.0. Use `checkoutDeliveryMethodUpdate` instead. + * @deprecated Use `checkoutDeliveryMethodUpdate` instead. */ checkoutShippingMethodUpdate?: Maybe; /** @@ -11632,7 +11556,7 @@ export type Mutation = { */ confirmEmailChange?: Maybe; /** - * Creates new warehouse. + * Creates a new warehouse. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ @@ -11649,10 +11573,6 @@ export type Mutation = { /** * Updates customers. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_USERS. * * Triggers the following webhook events: @@ -11714,7 +11634,7 @@ export type Mutation = { */ digitalContentDelete?: Maybe; /** - * Update digital content. + * Updates digital content. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ @@ -11753,7 +11673,7 @@ export type Mutation = { * Deletes order lines. * * Requires one of the following permissions: MANAGE_ORDERS. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ draftOrderLinesBulkDelete?: Maybe; /** @@ -11771,8 +11691,6 @@ export type Mutation = { /** * Export gift cards to csv file. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -11809,9 +11727,7 @@ export type Mutation = { externalLogout?: Maybe; /** * Trigger sending a notification with the notify plugin method. Serializes nodes provided as ids parameter and includes this data in the notification payload. - * - * Added in Saleor 3.1. - * @deprecated \n\nDEPRECATED: this mutation will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ externalNotificationTrigger?: Maybe; /** Obtain external access tokens for user by custom plugin. */ @@ -11838,8 +11754,6 @@ export type Mutation = { /** * Adds note to the gift card. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -11849,8 +11763,6 @@ export type Mutation = { /** * Activate gift cards. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -11858,9 +11770,7 @@ export type Mutation = { */ giftCardBulkActivate?: Maybe; /** - * Create gift cards. - * - * Added in Saleor 3.1. + * Creates gift cards. * * Requires one of the following permissions: MANAGE_GIFT_CARD. * @@ -11872,8 +11782,6 @@ export type Mutation = { /** * Deactivate gift cards. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -11881,9 +11789,7 @@ export type Mutation = { */ giftCardBulkDeactivate?: Maybe; /** - * Delete gift cards. - * - * Added in Saleor 3.1. + * Deletes gift cards. * * Requires one of the following permissions: MANAGE_GIFT_CARD. * @@ -11911,9 +11817,7 @@ export type Mutation = { */ giftCardDeactivate?: Maybe; /** - * Delete gift card. - * - * Added in Saleor 3.1. + * Deletes gift card. * * Requires one of the following permissions: MANAGE_GIFT_CARD. * @@ -11924,8 +11828,6 @@ export type Mutation = { /** * Resend a gift card. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. * * Triggers the following webhook events: @@ -12083,10 +11985,8 @@ export type Mutation = { /** * Adds note to the order. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. - * * Requires one of the following permissions: MANAGE_ORDERS. - * @deprecated This field will be removed in Saleor 4.0. Use `orderNoteAdd` instead. + * @deprecated Use `orderNoteAdd` instead. */ orderAddNote?: Maybe; /** @@ -12098,10 +11998,6 @@ export type Mutation = { /** * Creates multiple orders. * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS_IMPORT. */ orderBulkCreate?: Maybe; @@ -12126,8 +12022,6 @@ export type Mutation = { /** * Create new order from existing checkout. Requires the following permissions: AUTHENTICATED_APP and HANDLE_CHECKOUTS. * - * Added in Saleor 3.2. - * * 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. @@ -12174,8 +12068,6 @@ export type Mutation = { /** * Approve existing fulfillment. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_ORDERS. * * Triggers the following webhook events: @@ -12212,20 +12104,12 @@ export type Mutation = { /** * Adds granted refund to the order. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ orderGrantRefundCreate?: Maybe; /** * Updates granted refund. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ orderGrantRefundUpdate?: Maybe; @@ -12254,7 +12138,7 @@ export type Mutation = { */ orderLineUpdate?: Maybe; /** - * Create order lines for an order. + * Creates order lines for an order. * * Requires one of the following permissions: MANAGE_ORDERS. */ @@ -12268,20 +12152,12 @@ export type Mutation = { /** * Adds note to the order. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ orderNoteAdd?: Maybe; /** * Updates note of an order. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ orderNoteUpdate?: Maybe; @@ -12295,7 +12171,7 @@ export type Mutation = { * Update shop order settings across all channels. Returns `orderSettings` for the first `channel` in alphabetical order. * * Requires one of the following permissions: MANAGE_ORDERS. - * @deprecated \n\nDEPRECATED: this mutation will be removed in Saleor 4.0. Use `channelUpdate` mutation instead. + * @deprecated Use `channelUpdate` mutation instead. */ orderSettingsUpdate?: Maybe; /** @@ -12365,19 +12241,19 @@ export type Mutation = { */ pageTranslate?: Maybe; /** - * Delete page types. + * Deletes page types. * * Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. */ pageTypeBulkDelete?: Maybe; /** - * Create a new page type. + * Creates a new page type. * * Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. */ pageTypeCreate?: Maybe; /** - * Delete a page type. + * Deletes a page type. * * Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. */ @@ -12389,7 +12265,7 @@ export type Mutation = { */ pageTypeReorderAttributes?: Maybe; /** - * Update page type. + * Updates page type. * * Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. */ @@ -12414,21 +12290,11 @@ export type Mutation = { paymentCapture?: Maybe; /** Check payment balance. */ paymentCheckBalance?: Maybe; - /** - * 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. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** 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. */ paymentGatewayInitialize?: Maybe; /** * Initializes payment gateway for tokenizing payment method session. * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_USER. * * Triggers the following webhook events: @@ -12440,10 +12306,6 @@ export type Mutation = { /** * Tokenize payment method. * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_USER. * * Triggers the following webhook events: @@ -12453,10 +12315,6 @@ export type Mutation = { /** * Tokenize payment method. * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_USER. * * Triggers the following webhook events: @@ -12517,8 +12375,6 @@ export type Mutation = { /** * Update attributes assigned to product variant for given product type. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. */ productAttributeAssignmentUpdate?: Maybe; @@ -12531,10 +12387,6 @@ export type Mutation = { /** * Creates products. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_PRODUCTS. */ productBulkCreate?: Maybe; @@ -12547,10 +12399,6 @@ export type Mutation = { /** * Creates/updates translations for products. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. * * Triggers the following webhook events: @@ -12667,11 +12515,7 @@ export type Mutation = { */ productVariantBulkDelete?: Maybe; /** - * Creates/updates translations for products variants. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Creates/updates translations for product variants. * * Requires one of the following permissions: MANAGE_TRANSLATIONS. * @@ -12681,11 +12525,7 @@ export type Mutation = { */ productVariantBulkTranslate?: Maybe; /** - * Update multiple product variants. - * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Updates multiple product variants. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ @@ -12711,8 +12551,6 @@ export type Mutation = { /** * Deactivates product variant preorder. It changes all preorder allocation into regular allocation. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_PRODUCTS. */ productVariantPreorderDeactivate?: Maybe; @@ -12741,13 +12579,13 @@ export type Mutation = { */ productVariantStocksCreate?: Maybe; /** - * Delete stocks from product variant. + * Deletes stocks from product variant. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ productVariantStocksDelete?: Maybe; /** - * Update stocks for product variant. + * Updates stocks for product variant. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ @@ -12767,10 +12605,6 @@ export type Mutation = { /** * Deletes promotions. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -12780,10 +12614,6 @@ export type Mutation = { /** * Creates a new promotion. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -12794,10 +12624,6 @@ export type Mutation = { /** * Deletes a promotion. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -12807,10 +12633,6 @@ export type Mutation = { /** * Creates a new promotion rule. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -12820,10 +12642,6 @@ export type Mutation = { /** * Deletes a promotion rule. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -12833,18 +12651,12 @@ export type Mutation = { /** * Creates/updates translations for a promotion rule. * - * Added in Saleor 3.17. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. */ promotionRuleTranslate?: Maybe; /** * Updates an existing promotion rule. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -12854,18 +12666,12 @@ export type Mutation = { /** * Creates/updates translations for a promotion. * - * Added in Saleor 3.17. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. */ promotionTranslate?: Maybe; /** * Updates an existing promotion. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -12874,6 +12680,22 @@ export type Mutation = { * - PROMOTION_ENDED (async): Optionally called if promotion was ended. */ promotionUpdate?: Maybe; + /** + * 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. + * + * Added in Saleor 3.22. + * + * Requires one of the following permissions: MANAGE_SETTINGS. + */ + refundReasonReferenceClear?: Maybe; + /** + * Update refund settings across all channels. + * + * Added in Saleor 3.22. + * + * Requires one of the following permissions: MANAGE_SETTINGS. + */ + refundSettingsUpdate?: Maybe; /** * Request email change of the logged in user. * @@ -12905,82 +12727,71 @@ export type Mutation = { /** * Adds products, categories, collections to a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionRuleCreate` mutation instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: * - SALE_UPDATED (async): A sale was updated. + * @deprecated Use `promotionRuleCreate` and `promotionRuleUpdate` mutations instead. */ saleCataloguesAdd?: Maybe; /** * Removes products, categories, collections from a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionRuleUpdate` or `promotionRuleDelete` mutations instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: * - SALE_UPDATED (async): A sale was updated. + * @deprecated Use `promotionRuleUpdate` and `promotionRuleDelete` mutations instead. */ saleCataloguesRemove?: Maybe; /** * Manage sale's availability in channels. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionRuleCreate` or `promotionRuleUpdate` mutations instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. + * @deprecated Use `promotionRuleUpdate` mutation instead. */ saleChannelListingUpdate?: Maybe; /** * Creates a new sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionCreate` mutation instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: * - SALE_CREATED (async): A sale was created. + * @deprecated Use `promotionCreate` mutation instead. */ saleCreate?: Maybe; /** * Deletes a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionDelete` mutation instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: * - SALE_DELETED (async): A sale was deleted. + * @deprecated Use `promotionDelete` mutation instead. */ saleDelete?: Maybe; /** * Creates/updates translations for a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `PromotionTranslate` mutation instead. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. + * @deprecated Use `promotionTranslate` mutation instead. */ saleTranslate?: Maybe; /** * Updates a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionUpdate` mutation instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: * - SALE_UPDATED (async): A sale was updated. * - SALE_TOGGLE (async): Optionally triggered when a sale is started or stopped. + * @deprecated Use `promotionUpdate` mutation instead. */ saleUpdate?: Maybe; /** * Sends a notification confirmation. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_USER. * * Triggers the following webhook events: @@ -13071,17 +12882,15 @@ export type Mutation = { /** * Updates site domain of the shop. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `PUBLIC_URL` environment variable instead. - * * Requires one of the following permissions: MANAGE_SETTINGS. - * @deprecated \n\nDEPRECATED: this mutation will be removed in Saleor 4.0. Use `PUBLIC_URL` environment variable instead. + * @deprecated Use `PUBLIC_URL` environment variable instead. */ shopDomainUpdate?: Maybe; /** * Fetch tax rates. * * Requires one of the following permissions: MANAGE_SETTINGS. - * @deprecated \n\nDEPRECATED: this mutation will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ shopFetchTaxRates?: Maybe; /** @@ -13135,7 +12944,7 @@ export type Mutation = { */ staffNotificationRecipientCreate?: Maybe; /** - * Delete staff notification recipient. + * Deletes staff notification recipient. * * Requires one of the following permissions: MANAGE_SETTINGS. */ @@ -13158,10 +12967,6 @@ export type Mutation = { /** * 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. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_PRODUCTS. * * Triggers the following webhook events: @@ -13171,10 +12976,6 @@ export type Mutation = { /** * Request to delete a stored payment method on payment provider side. * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_USER. * * Triggers the following webhook events: @@ -13182,33 +12983,25 @@ export type Mutation = { */ storedPaymentMethodRequestDelete?: Maybe; /** - * Create a tax class. - * - * Added in Saleor 3.9. + * Creates a tax class. * * Requires one of the following permissions: MANAGE_TAXES. */ taxClassCreate?: Maybe; /** - * Delete a tax class. After deleting the tax class any products, product types or shipping methods using it are updated to use the default tax class. - * - * Added in Saleor 3.9. + * 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. * * Requires one of the following permissions: MANAGE_TAXES. */ taxClassDelete?: Maybe; /** - * Update a tax class. - * - * Added in Saleor 3.9. + * Updates a tax class. * * Requires one of the following permissions: MANAGE_TAXES. */ taxClassUpdate?: Maybe; /** - * Update tax configuration for a channel. - * - * Added in Saleor 3.9. + * Updates tax configuration for a channel. * * Requires one of the following permissions: MANAGE_TAXES. */ @@ -13216,15 +13009,11 @@ export type Mutation = { /** * Remove all tax class rates for a specific country. * - * Added in Saleor 3.9. - * * Requires one of the following permissions: MANAGE_TAXES. */ taxCountryConfigurationDelete?: Maybe; /** - * Update tax class rates for a specific country. - * - * Added in Saleor 3.9. + * Updates tax class rates for a specific country. * * Requires one of the following permissions: MANAGE_TAXES. */ @@ -13232,8 +13021,6 @@ export type Mutation = { /** * Exempt checkout or order from charging the taxes. When tax exemption is enabled, taxes won't be charged for the checkout or order. Taxes may still be calculated in cases when product prices are entered with the tax included and the net price needs to be known. * - * Added in Saleor 3.8. - * * Requires one of the following permissions: MANAGE_TAXES. */ taxExemptionManage?: Maybe; @@ -13250,11 +13037,7 @@ export type Mutation = { */ tokensDeactivateAll?: Maybe; /** - * Create transaction for checkout or order. - * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Creates transaction for checkout or order. * * Requires one of the following permissions: HANDLE_PAYMENTS. */ @@ -13262,56 +13045,33 @@ export type Mutation = { /** * Report the event for the transaction. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app. - */ - transactionEventReport?: 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. - * - * Added in Saleor 3.13. * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Triggers the following webhook events: + * - TRANSACTION_ITEM_METADATA_UPDATED (async): Optionally called when transaction's metadata was updated. + * - 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. */ + 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`. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. */ transactionProcess?: Maybe; /** * Request an action for payment transaction. * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: HANDLE_PAYMENTS. */ transactionRequestAction?: Maybe; /** * Request a refund for payment transaction based on granted refund. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: HANDLE_PAYMENTS. */ transactionRequestRefundForGrantedRefund?: Maybe; /** * Update transaction. * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app. */ transactionUpdate?: Maybe; @@ -13321,9 +13081,17 @@ export type Mutation = { * Requires one of the following permissions: MANAGE_PRODUCTS. */ unassignWarehouseShippingZone?: Maybe; - /** Updates metadata of an object. To use it, you need to have access to the modified object. */ + /** + * Updates metadata of an object.Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ updateMetadata?: Maybe; - /** Updates private metadata of an object. To use it, you need to be an authenticated staff user or an app and have access to the modified object. */ + /** + * Updates private metadata of an object. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ updatePrivateMetadata?: Maybe; /** * Updates given warehouse. @@ -13450,7 +13218,7 @@ export type Mutation = { */ webhookCreate?: Maybe; /** - * Delete a webhook. Before the deletion, the webhook is deactivated to pause any deliveries that are already scheduled. The deletion might fail if delivery is in progress. In such a case, the webhook is not deleted but remains deactivated. + * 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. * * Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP. */ @@ -13458,20 +13226,12 @@ export type Mutation = { /** * Performs a dry run of a webhook event. Supports a single event (the first, if multiple provided in the `query`). Requires permission relevant to processed event. * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER. */ webhookDryRun?: Maybe; /** * Trigger a webhook event. Supports a single event (the first, if multiple provided in the `webhook.subscription_query`). Requires permission relevant to processed event. Successfully delivered webhook returns `delivery` with status='PENDING' and empty payload. * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER. */ webhookTrigger?: Maybe; @@ -13589,6 +13349,11 @@ export type MutationAppInstallArgs = { }; +export type MutationAppReenableSyncWebhooksArgs = { + appId: Scalars['ID']['input']; +}; + + export type MutationAppRetryInstallArgs = { activateAfterInstallation?: InputMaybe; id: Scalars['ID']['input']; @@ -13793,6 +13558,7 @@ export type MutationCheckoutBillingAddressUpdateArgs = { billingAddress: AddressInput; checkoutId?: InputMaybe; id?: InputMaybe; + saveAddress?: InputMaybe; token?: InputMaybe; validationRules?: InputMaybe; }; @@ -13834,6 +13600,12 @@ export type MutationCheckoutCustomerDetachArgs = { }; +export type MutationCheckoutCustomerNoteUpdateArgs = { + customerNote: Scalars['String']['input']; + id: Scalars['ID']['input']; +}; + + export type MutationCheckoutDeliveryMethodUpdateArgs = { deliveryMethodId?: InputMaybe; id?: InputMaybe; @@ -13908,6 +13680,7 @@ export type MutationCheckoutRemovePromoCodeArgs = { export type MutationCheckoutShippingAddressUpdateArgs = { checkoutId?: InputMaybe; id?: InputMaybe; + saveAddress?: InputMaybe; shippingAddress: AddressInput; token?: InputMaybe; validationRules?: InputMaybe; @@ -14937,6 +14710,11 @@ export type MutationPromotionUpdateArgs = { }; +export type MutationRefundSettingsUpdateArgs = { + input: RefundSettingsUpdateInput; +}; + + export type MutationRequestEmailChangeArgs = { channel?: InputMaybe; newEmail: Scalars['String']['input']; @@ -15213,14 +14991,17 @@ export type MutationTransactionCreateArgs = { export type MutationTransactionEventReportArgs = { - amount: Scalars['PositiveDecimal']['input']; + amount?: InputMaybe; availableActions?: InputMaybe>; externalUrl?: InputMaybe; id?: InputMaybe; message?: InputMaybe; + paymentMethodDetails?: InputMaybe; pspReference: Scalars['String']['input']; time?: InputMaybe; token?: InputMaybe; + transactionMetadata?: InputMaybe>; + transactionPrivateMetadata?: InputMaybe>; type: TransactionEventTypeEnum; }; @@ -15247,6 +15028,8 @@ export type MutationTransactionRequestActionArgs = { actionType: TransactionActionEnum; amount?: InputMaybe; id?: InputMaybe; + refundReason?: InputMaybe; + refundReasonReference?: InputMaybe; token?: InputMaybe; }; @@ -15402,12 +15185,62 @@ export type NavigationType = /** Secondary storefront navigation. */ | 'SECONDARY'; +/** Represents the NEW_TAB target options for an app extension. */ +export type NewTabTargetOptions = { + __typename?: 'NewTabTargetOptions'; + /** + * HTTP method for New Tab target (GET or POST) + * @deprecated Use `settings` field directly. + */ + method: HttpMethod; +}; + /** An object with an ID */ export type Node = { /** The ID of the object. */ id: Scalars['ID']['output']; }; +/** + * An object with attributes. + * + * Added in Saleor 3.22. + */ +export type ObjectWithAttributes = { + /** + * Get a single attribute attached to the object by attribute slug. + * + * Added in Saleor 3.22. + */ + assignedAttribute?: Maybe; + /** + * List of attributes assigned to the object. + * + * Added in Saleor 3.22. + */ + assignedAttributes: Array; +}; + + +/** + * An object with attributes. + * + * Added in Saleor 3.22. + */ +export type ObjectWithAttributesAssignedAttributeArgs = { + slug: Scalars['String']['input']; +}; + + +/** + * An object with attributes. + * + * Added in Saleor 3.22. + */ +export type ObjectWithAttributesAssignedAttributesArgs = { + limit?: InputMaybe; +}; + export type ObjectWithMetadata = { /** List of public metadata items. Can be accessed without permissions. */ metadata: Array; @@ -15456,17 +15289,9 @@ export type Order = Node & ObjectWithMetadata & { __typename?: 'Order'; /** List of actions that can be performed in the current state of an order. */ actions: Array; - /** - * The authorize status of the order. - * - * Added in Saleor 3.4. - */ + /** The authorize status of the order. */ authorizeStatus: OrderAuthorizeStatusEnum; - /** - * Collection points that can be used for this order. - * - * Added in Saleor 3.1. - */ + /** Collection points that can be used for this order. */ availableCollectionPoints: Array; /** * Shipping methods that can be used with this order. @@ -15479,17 +15304,9 @@ export type Order = Node & ObjectWithMetadata & { canFinalize: Scalars['Boolean']['output']; /** Channel through which the order was placed. */ channel: Channel; - /** - * The charge status of the order. - * - * Added in Saleor 3.4. - */ + /** The charge status of the order. */ chargeStatus: OrderChargeStatusEnum; - /** - * ID of the checkout that the order was created from. - * - * Added in Saleor 3.11. - */ + /** ID of the checkout that the order was created from. */ checkoutId?: Maybe; /** Name of the collection point where the order should be picked up by the customer. */ collectionPointName?: Maybe; @@ -15497,29 +15314,21 @@ export type Order = Node & ObjectWithMetadata & { created: Scalars['DateTime']['output']; /** Additional information provided by the customer about the order. */ customerNote: Scalars['String']['output']; - /** - * The delivery method selected for this order. - * - * Added in Saleor 3.1. - */ + /** The delivery method selected for this order. */ deliveryMethod?: Maybe; /** * Returns applied discount. - * @deprecated This field will be removed in Saleor 4.0. Use the `discounts` field instead. + * @deprecated Use the `discounts` field instead. */ discount?: Maybe; /** * Discount name. - * @deprecated This field will be removed in Saleor 4.0. Use the `discounts` field instead. + * @deprecated Use the `discounts` field instead. */ discountName?: Maybe; /** List of all discounts assigned to the order. */ discounts: Array; - /** - * Determines whether displayed prices should include taxes. - * - * Added in Saleor 3.9. - */ + /** Determines whether displayed prices should include taxes. */ displayGrossPrices: Scalars['Boolean']['output']; /** List of errors that occurred during order validation. */ errors: Array; @@ -15529,11 +15338,7 @@ export type Order = Node & ObjectWithMetadata & { * Requires one of the following permissions: MANAGE_ORDERS. */ events: Array; - /** - * External ID of this order. - * - * Added in Saleor 3.10. - */ + /** External ID of this order. */ externalReference?: Maybe; /** List of shipments for the order. */ fulfillments: Array; @@ -15542,10 +15347,6 @@ export type Order = Node & ObjectWithMetadata & { /** * List of granted refunds. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ grantedRefunds: Array; @@ -15557,7 +15358,7 @@ export type Order = Node & ObjectWithMetadata & { isPaid: Scalars['Boolean']['output']; /** Returns True, if order requires shipping. */ isShippingRequired: Scalars['Boolean']['output']; - /** @deprecated This field will be removed in Saleor 4.0. Use the `languageCodeEnum` field to fetch the language code. */ + /** @deprecated Use the `languageCodeEnum` field to fetch the language code. */ languageCode: Scalars['String']['output']; /** Order language code. */ languageCodeEnum: LanguageCodeEnum; @@ -15569,15 +15370,9 @@ export type Order = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** User-friendly number of an order. */ number: Scalars['String']['output']; @@ -15597,15 +15392,9 @@ export type Order = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** URL to which user should be redirected after order is placed. */ redirectUrl?: Maybe; @@ -15613,7 +15402,7 @@ export type Order = Node & ObjectWithMetadata & { shippingAddress?: Maybe
; /** * Shipping method for this order. - * @deprecated This field will be removed in Saleor 4.0. Use `deliveryMethod` instead. + * @deprecated Use `deliveryMethod` instead. */ shippingMethod?: Maybe; /** Method used for shipping. */ @@ -15625,28 +15414,14 @@ export type Order = Node & ObjectWithMetadata & { /** * Denormalized tax class assigned to the shipping method. * - * Added in Saleor 3.9. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */ shippingTaxClass?: Maybe; - /** - * Denormalized public metadata of the shipping method's tax class. - * - * Added in Saleor 3.9. - */ + /** Denormalized public metadata of the shipping method's tax class. */ shippingTaxClassMetadata: Array; - /** - * Denormalized name of the tax class assigned to the shipping method. - * - * Added in Saleor 3.9. - */ + /** Denormalized name of the tax class assigned to the shipping method. */ shippingTaxClassName?: Maybe; - /** - * Denormalized private metadata of the shipping method's tax class. Requires staff permissions to access. - * - * Added in Saleor 3.9. - */ + /** Denormalized private metadata of the shipping method's tax class. Requires staff permissions to access. */ shippingTaxClassPrivateMetadata: Array; /** The shipping tax rate value. */ shippingTaxRate: Scalars['Float']['output']; @@ -15656,23 +15431,15 @@ export type Order = Node & ObjectWithMetadata & { statusDisplay: Scalars['String']['output']; /** The sum of line prices not including shipping. */ subtotal: TaxedMoney; - /** - * Returns True if order has to be exempt from taxes. - * - * Added in Saleor 3.8. - */ + /** Returns True if order has to be exempt from taxes. */ taxExemption: Scalars['Boolean']['output']; - /** @deprecated This field will be removed in Saleor 4.0. Use `id` instead. */ + /** @deprecated Use `id` instead. */ token: Scalars['String']['output']; /** Total amount of the order. */ total: TaxedMoney; /** * Total amount of ongoing authorize requests for the order's transactions. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ totalAuthorizePending: Money; @@ -15683,89 +15450,51 @@ export type Order = Node & ObjectWithMetadata & { /** * Total amount of ongoing cancel requests for the order's transactions. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ totalCancelPending: Money; - /** - * Amount canceled for the order. - * - * Added in Saleor 3.13. - */ + /** Amount canceled for the order. */ totalCanceled: Money; /** * Amount captured for the order. - * @deprecated This field will be removed in Saleor 4.0. Use `totalCharged` instead. + * @deprecated Use `totalCharged` instead. */ totalCaptured: Money; /** * Total amount of ongoing charge requests for the order's transactions. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ totalChargePending: Money; - /** - * Amount charged for the order. - * - * Added in Saleor 3.13. - */ + /** Amount charged for the order. */ totalCharged: Money; /** * Total amount of granted refund. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ totalGrantedRefund: Money; /** * Total amount of ongoing refund requests for the order's transactions. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ totalRefundPending: Money; - /** - * Total refund amount for the order. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Total refund amount for the order. */ totalRefunded: Money; /** * The difference amount between granted refund and the amounts that are pending and refunded. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ totalRemainingGrant: Money; - /** Google Analytics tracking client ID. This field will be removed in Saleor 4.0. */ + /** Google Analytics tracking client ID. */ trackingClientId: Scalars['String']['output']; - /** - * List of transactions for the order. Requires one of the following permissions: MANAGE_ORDERS, HANDLE_PAYMENTS. - * - * Added in Saleor 3.4. - */ + /** List of transactions for the order. Requires one of the following permissions: MANAGE_ORDERS, HANDLE_PAYMENTS. */ transactions: Array; /** * Translated discount name. - * @deprecated This field will be removed in Saleor 4.0. Use the `discounts` field instead. + * @deprecated Use the `discounts` field instead. */ translatedDiscountName?: Maybe; /** @@ -15773,7 +15502,7 @@ export type Order = Node & ObjectWithMetadata & { * * Added in Saleor 3.19. */ - undiscountedShippingPrice?: Maybe; + undiscountedShippingPrice: Money; /** Undiscounted total amount of the order. */ undiscountedTotal: TaxedMoney; /** Date and time when the order was created. */ @@ -15831,8 +15560,6 @@ export type OrderAction = /** * Adds note to the order. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. - * * Requires one of the following permissions: MANAGE_ORDERS. */ export type OrderAddNote = { @@ -15842,16 +15569,12 @@ export type OrderAddNote = { event?: Maybe; /** Order with the note added. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; export type OrderAddNoteInput = { - /** - * Note message. - * - * DEPRECATED: this field will be removed in Saleor 4.0. - */ + /** Note message. */ message: Scalars['String']['input']; }; @@ -15876,6 +15599,14 @@ export type OrderAuthorizeStatusEnum = | 'NONE' | 'PARTIAL'; +/** Filter by authorize status. */ +export type OrderAuthorizeStatusEnumFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value included in. */ + oneOf?: InputMaybe>; +}; + /** * Cancels orders. * @@ -15886,17 +15617,13 @@ export type OrderBulkCancel = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; /** * Creates multiple orders. * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS_IMPORT. */ export type OrderBulkCreate = { @@ -15917,11 +15644,19 @@ export type OrderBulkCreateDeliveryMethodInput = { shippingPrice?: InputMaybe; /** The ID of the tax class. */ shippingTaxClassId?: InputMaybe; - /** Metadata of the tax class. */ + /** + * Metadata of the tax class. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ shippingTaxClassMetadata?: InputMaybe>; /** The name of the tax class. */ shippingTaxClassName?: InputMaybe; - /** Private metadata of the tax class. */ + /** + * Private metadata of the tax class. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ shippingTaxClassPrivateMetadata?: InputMaybe>; /** Tax rate of the shipping. */ shippingTaxRate?: InputMaybe; @@ -15941,7 +15676,6 @@ export type OrderBulkCreateError = { path?: Maybe; }; -/** An enumeration. */ export type OrderBulkCreateErrorCode = | 'BULK_LIMIT' | 'FUTURE_DATE' @@ -16013,11 +15747,19 @@ export type OrderBulkCreateInput = { languageCode: LanguageCodeEnum; /** List of order lines. */ lines: Array; - /** Metadata of the order. */ + /** + * Metadata of the order. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ metadata?: InputMaybe>; /** Notes related to the order. */ notes?: InputMaybe>; - /** Private metadata of the order. */ + /** + * Private metadata of the order. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ privateMetadata?: InputMaybe>; /** URL of a view, where users should be redirected to see the order details. */ redirectUrl?: InputMaybe; @@ -16042,11 +15784,19 @@ export type OrderBulkCreateInput = { export type OrderBulkCreateInvoiceInput = { /** The date, when the invoice was created. */ createdAt: Scalars['DateTime']['input']; - /** Metadata of the invoice. */ + /** + * Metadata of the invoice. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ metadata?: InputMaybe>; /** Invoice number. */ number?: InputMaybe; - /** Private metadata of the invoice. */ + /** + * Private metadata of the invoice. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ privateMetadata?: InputMaybe>; /** URL of the invoice to download. */ url?: InputMaybe; @@ -16074,21 +15824,43 @@ export type OrderBulkCreateOrderLineInput = { isGiftCard: Scalars['Boolean']['input']; /** Determines whether shipping of the order line items is required. */ isShippingRequired: Scalars['Boolean']['input']; - /** Metadata of the order line. */ + /** + * Metadata of the order line. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ metadata?: InputMaybe>; - /** Private metadata of the order line. */ + /** + * Private metadata of the order line. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ privateMetadata?: InputMaybe>; /** The name of the product. */ productName?: InputMaybe; + /** + * The SKU of the product. + * + * Added in Saleor 3.18. + */ + productSku?: InputMaybe; /** Number of items in the order line */ quantity: Scalars['Int']['input']; /** The ID of the tax class. */ taxClassId?: InputMaybe; - /** Metadata of the tax class. */ + /** + * Metadata of the tax class. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ taxClassMetadata?: InputMaybe>; /** The name of the tax class. */ taxClassName?: InputMaybe; - /** Private metadata of the tax class. */ + /** + * Private metadata of the tax class. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ taxClassPrivateMetadata?: InputMaybe>; /** Tax rate of the order line. */ taxRate?: InputMaybe; @@ -16100,6 +15872,24 @@ export type OrderBulkCreateOrderLineInput = { translatedVariantName?: InputMaybe; /** Price of the order line excluding applied discount. */ undiscountedTotalPrice: TaxedMoneyInput; + /** + * Reason of the discount on order line. + * + * Added in Saleor 3.19. + */ + unitDiscountReason?: InputMaybe; + /** + * Type of the discount: fixed or percent + * + * Added in Saleor 3.19. + */ + unitDiscountType?: InputMaybe; + /** + * Value of the discount. Can store fixed value or percent value + * + * Added in Saleor 3.19. + */ + unitDiscountValue?: InputMaybe; /** The external ID of the product variant. */ variantExternalReference?: InputMaybe; /** The ID of the product variant. */ @@ -16129,13 +15919,7 @@ export type OrderBulkCreateUserInput = { id?: InputMaybe; }; -/** - * Event sent when orders are imported. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when orders are imported. */ export type OrderBulkCreated = Event & { __typename?: 'OrderBulkCreated'; /** Time of the event. */ @@ -16160,15 +15944,11 @@ export type OrderCancel = { errors: Array; /** Canceled order. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; -/** - * Event sent when order is canceled. - * - * Added in Saleor 3.2. - */ +/** Event sent when order is canceled. */ export type OrderCancelled = Event & { __typename?: 'OrderCancelled'; /** Time of the event. */ @@ -16193,7 +15973,7 @@ export type OrderCapture = { errors: Array; /** Captured order. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -16223,6 +16003,14 @@ export type OrderChargeStatusEnum = | 'OVERCHARGED' | 'PARTIAL'; +/** Filter by charge status. */ +export type OrderChargeStatusEnumFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value included in. */ + oneOf?: InputMaybe>; +}; + /** * Confirms an unconfirmed order by changing status to unfulfilled. * @@ -16231,16 +16019,13 @@ export type OrderChargeStatusEnum = export type OrderConfirm = { __typename?: 'OrderConfirm'; errors: Array; + /** Order which has been confirmed. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; -/** - * Event sent when order is confirmed. - * - * Added in Saleor 3.2. - */ +/** Event sent when order is confirmed. */ export type OrderConfirmed = Event & { __typename?: 'OrderConfirmed'; /** Time of the event. */ @@ -16275,8 +16060,6 @@ export type OrderCountableEdge = { /** * Create new order from existing checkout. Requires the following permissions: AUTHENTICATED_APP and HANDLE_CHECKOUTS. * - * Added in Saleor 3.2. - * * 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. @@ -16310,7 +16093,6 @@ export type OrderCreateFromCheckoutError = { variants?: Maybe>; }; -/** An enumeration. */ export type OrderCreateFromCheckoutErrorCode = | 'BILLING_ADDRESS_NOT_SET' | 'CHANNEL_INACTIVE' @@ -16327,11 +16109,7 @@ export type OrderCreateFromCheckoutErrorCode = | 'UNAVAILABLE_VARIANT_IN_CHANNEL' | 'VOUCHER_NOT_APPLICABLE'; -/** - * Event sent when new order is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new order is created. */ export type OrderCreated = Event & { __typename?: 'OrderCreated'; /** Time of the event. */ @@ -16355,7 +16133,10 @@ export type OrderDirection = /** Contains all details related to the applied discount to the order. */ export type OrderDiscount = Node & { __typename?: 'OrderDiscount'; - /** Returns amount of discount. */ + /** + * Returns amount of discount. + * @deprecated Use `total` instead. + */ amount: Money; /** The ID of discount applied. */ id: Scalars['ID']['output']; @@ -16367,6 +16148,12 @@ export type OrderDiscount = Node & { * Requires one of the following permissions: MANAGE_ORDERS. */ reason?: Maybe; + /** + * The amount of discount applied to the order. + * + * Added in Saleor 3.21. + */ + total: Money; /** Translated name of the applied discount. */ translatedName?: Maybe; /** The type of applied discount: Sale, Voucher or Manual. */ @@ -16387,7 +16174,7 @@ export type OrderDiscountAdd = { errors: Array; /** Order which has been discounted. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -16410,11 +16197,10 @@ export type OrderDiscountDelete = { errors: Array; /** Order which has removed discount. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; -/** An enumeration. */ export type OrderDiscountType = | 'MANUAL' | 'ORDER_PROMOTION' @@ -16432,7 +16218,7 @@ export type OrderDiscountUpdate = { errors: Array; /** Order which has been discounted. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -16462,7 +16248,6 @@ export type OrderError = { warehouse?: Maybe; }; -/** An enumeration. */ export type OrderErrorCode = | 'BILLING_ADDRESS_NOT_SET' | 'CANNOT_CANCEL_FULFILLMENT' @@ -16482,6 +16267,7 @@ export type OrderErrorCode = | 'INVALID_QUANTITY' | 'INVALID_VOUCHER' | 'INVALID_VOUCHER_CODE' + | 'MISSING_ADDRESS_DATA' | 'NON_EDITABLE_GIFT_LINE' | 'NON_REMOVABLE_GIFT_LINE' | 'NOT_AVAILABLE_IN_CHANNEL' @@ -16540,13 +16326,7 @@ export type OrderEvent = Node & { quantity?: Maybe; /** The reference of payment's transaction. */ reference?: Maybe; - /** - * The order event which is related to this event. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The order event which is related to this event. */ related?: Maybe; /** The order which is related to this order. */ relatedOrder?: Maybe; @@ -16597,6 +16377,14 @@ export type OrderEventDiscountObject = { valueType: DiscountValueTypeEnum; }; +/** Filter input for order events data. */ +export type OrderEventFilterInput = { + /** Filter order events by date. */ + date?: InputMaybe; + /** Filter order events by type. */ + type?: InputMaybe; +}; + export type OrderEventOrderLineObject = { __typename?: 'OrderEventOrderLineObject'; /** The discount applied to the order line. */ @@ -16609,7 +16397,13 @@ export type OrderEventOrderLineObject = { quantity?: Maybe; }; -/** An enumeration. */ +export type OrderEventTypeEnumFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value included in. */ + oneOf?: InputMaybe>; +}; + export type OrderEventsEmailsEnum = | 'CONFIRMED' | 'DIGITAL_LINKS' @@ -16663,6 +16457,7 @@ export type OrderEventsEnum = | 'PAYMENT_REFUNDED' | 'PAYMENT_VOIDED' | 'PLACED' + | 'PLACED_AUTOMATICALLY_FROM_PAID_CHECKOUT' | 'PLACED_FROM_DRAFT' | 'REMOVED_PRODUCTS' | 'TRACKING_UPDATED' @@ -16673,13 +16468,7 @@ export type OrderEventsEnum = | 'TRANSACTION_REFUND_REQUESTED' | 'UPDATED_ADDRESS'; -/** - * Event sent when order becomes expired. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when order becomes expired. */ export type OrderExpired = Event & { __typename?: 'OrderExpired'; /** Time of the event. */ @@ -16715,11 +16504,7 @@ export type OrderFilterInput = { updatedAt?: InputMaybe; }; -/** - * Filter shipping methods for order. - * - * Added in Saleor 3.6. - */ +/** Filter shipping methods for order. */ export type OrderFilterShippingMethods = Event & { __typename?: 'OrderFilterShippingMethods'; /** Time of the event. */ @@ -16730,11 +16515,7 @@ export type OrderFilterShippingMethods = Event & { order?: Maybe; /** The application receiving the webhook. */ recipient?: Maybe; - /** - * Shipping methods that can be used with this checkout. - * - * Added in Saleor 3.6. - */ + /** Shipping methods that can be used with this checkout. */ shippingMethods?: Maybe>; /** Saleor version that triggered the event. */ version?: Maybe; @@ -16758,7 +16539,7 @@ export type OrderFulfill = { fulfillments?: Maybe>; /** Fulfilled order. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -16769,11 +16550,7 @@ export type OrderFulfillInput = { lines: Array; /** If true, send an email notification to the customer. */ notifyCustomer?: InputMaybe; - /** - * Fulfillment tracking number. - * - * Added in Saleor 3.6. - */ + /** Fulfillment tracking number. */ trackingNumber?: InputMaybe; }; @@ -16791,11 +16568,7 @@ export type OrderFulfillStockInput = { warehouse: Scalars['ID']['input']; }; -/** - * Event sent when order is fulfilled. - * - * Added in Saleor 3.2. - */ +/** Event sent when order is fulfilled. */ export type OrderFulfilled = Event & { __typename?: 'OrderFulfilled'; /** Time of the event. */ @@ -16810,11 +16583,7 @@ export type OrderFulfilled = Event & { version?: Maybe; }; -/** - * Event sent when order is fully paid. - * - * Added in Saleor 3.2. - */ +/** Event sent when order is fully paid. */ export type OrderFullyPaid = Event & { __typename?: 'OrderFullyPaid'; /** Time of the event. */ @@ -16829,13 +16598,7 @@ export type OrderFullyPaid = Event & { version?: Maybe; }; -/** - * The order is fully refunded. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** The order is fully refunded. */ export type OrderFullyRefunded = Event & { __typename?: 'OrderFullyRefunded'; /** Time of the event. */ @@ -16853,10 +16616,6 @@ export type OrderFullyRefunded = Event & { /** * Adds granted refund to the order. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ export type OrderGrantRefundCreate = { @@ -16874,19 +16633,12 @@ export type OrderGrantRefundCreateError = { code: OrderGrantRefundCreateErrorCode; /** 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; - /** - * List of lines which cause the error. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of lines which cause the error. */ lines?: Maybe>; /** The error message. */ message?: Maybe; }; -/** An enumeration. */ export type OrderGrantRefundCreateErrorCode = | 'AMOUNT_GREATER_THAN_AVAILABLE' | 'GRAPHQL_ERROR' @@ -16898,32 +16650,26 @@ export type OrderGrantRefundCreateErrorCode = export type OrderGrantRefundCreateInput = { /** Amount of the granted refund. If not provided, the amount will be calculated automatically based on provided `lines` and `grantRefundForShipping`. */ amount?: InputMaybe; - /** - * Determine if granted refund should include shipping costs. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Determine if granted refund should include shipping costs. */ grantRefundForShipping?: InputMaybe; - /** - * Lines to assign to granted refund. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Lines to assign to granted refund. */ lines?: InputMaybe>; /** Reason of the granted refund. */ reason?: InputMaybe; /** - * The ID of the transaction item related to the granted refund. If `amount` provided in the input, the transaction.chargedAmount needs to be equal or greater than provided `amount`.If `amount` is not provided in the input and calculated automatically by Saleor, the `min(calculatedAmount, transaction.chargedAmount)` will be used.Field will be required starting from Saleor 3.21. + * ID of a `Page` (Model) to reference in reason. + * + * Added in Saleor 3.22. + */ + reasonReference?: InputMaybe; + /** + * The ID of the transaction item related to the granted refund. If `amount` provided in the input, the transaction.chargedAmount needs to be equal or greater than provided `amount`.If `amount` is not provided in the input and calculated automatically by Saleor, the `min(calculatedAmount, transaction.chargedAmount)` will be used. Field required starting from Saleor 3.21. * * Added in Saleor 3.20. * * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ - transactionId?: InputMaybe; + transactionId: Scalars['ID']['input']; }; export type OrderGrantRefundCreateLineError = { @@ -16938,7 +16684,6 @@ export type OrderGrantRefundCreateLineError = { message?: Maybe; }; -/** An enumeration. */ export type OrderGrantRefundCreateLineErrorCode = | 'GRAPHQL_ERROR' | 'NOT_FOUND' @@ -16956,10 +16701,6 @@ export type OrderGrantRefundCreateLineInput = { /** * Updates granted refund. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ export type OrderGrantRefundUpdate = { @@ -16973,13 +16714,7 @@ export type OrderGrantRefundUpdate = { export type OrderGrantRefundUpdateError = { __typename?: 'OrderGrantRefundUpdateError'; - /** - * List of lines to add which cause the error. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of lines to add which cause the error. */ addLines?: Maybe>; /** The error code. */ code: OrderGrantRefundUpdateErrorCode; @@ -16987,17 +16722,10 @@ export type OrderGrantRefundUpdateError = { field?: Maybe; /** The error message. */ message?: Maybe; - /** - * List of lines to remove which cause the error. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of lines to remove which cause the error. */ removeLines?: Maybe>; }; -/** An enumeration. */ export type OrderGrantRefundUpdateErrorCode = | 'AMOUNT_GREATER_THAN_AVAILABLE' | 'GRAPHQL_ERROR' @@ -17007,33 +16735,21 @@ export type OrderGrantRefundUpdateErrorCode = | 'SHIPPING_COSTS_ALREADY_GRANTED'; export type OrderGrantRefundUpdateInput = { - /** - * Lines to assign to granted refund. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Lines to assign to granted refund. */ addLines?: InputMaybe>; /** Amount of the granted refund. if not provided and `addLines` or `removeLines` or `grantRefundForShipping` is provided, amount will be calculated automatically. */ amount?: InputMaybe; - /** - * Determine if granted refund should include shipping costs. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Determine if granted refund should include shipping costs. */ grantRefundForShipping?: InputMaybe; /** Reason of the granted refund. */ reason?: InputMaybe; /** - * Lines to remove from granted refund. - * - * Added in Saleor 3.15. + * ID of a `Page` (Model) to reference in reason. * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Added in Saleor 3.22. */ + reasonReference?: InputMaybe; + /** Lines to remove from granted refund. */ removeLines?: InputMaybe>; /** * The ID of the transaction item related to the granted refund. If `amount` provided in the input, the transaction.chargedAmount needs to be equal or greater than provided `amount`.If `amount` is not provided in the input and calculated automatically by Saleor, the `min(calculatedAmount, transaction.chargedAmount)` will be used.Field will be required starting from Saleor 3.21. @@ -17066,19 +16782,12 @@ export type OrderGrantRefundUpdateLineError = { message?: Maybe; }; -/** An enumeration. */ export type OrderGrantRefundUpdateLineErrorCode = - | 'GRAPHQL_ERROR' - | 'NOT_FOUND' - | 'QUANTITY_GREATER_THAN_AVAILABLE'; - -/** - * The details of granted refund. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + | 'GRAPHQL_ERROR' + | 'NOT_FOUND' + | 'QUANTITY_GREATER_THAN_AVAILABLE'; + +/** The details of granted refund. */ export type OrderGrantedRefund = { __typename?: 'OrderGrantedRefund'; /** Refund amount. */ @@ -17088,23 +16797,21 @@ export type OrderGrantedRefund = { /** Time of creation. */ createdAt: Scalars['DateTime']['output']; id: Scalars['ID']['output']; + /** Lines assigned to the granted refund. */ + lines?: Maybe>; /** - * Lines assigned to the granted refund. - * - * Added in Saleor 3.15. + * Reason of the refund. * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Added in Saleor 3.22. */ - lines?: Maybe>; - /** Reason of the refund. */ reason?: Maybe; /** - * If true, the refunded amount includes the shipping price.If false, the refunded amount does not include the shipping price. + * Reason Model (Page) reference for refund. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Added in Saleor 3.22. */ + reasonReference?: Maybe; + /** If true, the refunded amount includes the shipping price.If false, the refunded amount does not include the shipping price. */ shippingCostsIncluded: Scalars['Boolean']['output']; /** * Status of the granted refund calculated based on transactionItem assigned to granted refund. @@ -17130,13 +16837,7 @@ export type OrderGrantedRefund = { user?: Maybe; }; -/** - * Represents granted refund line. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents granted refund line. */ export type OrderGrantedRefundLine = { __typename?: 'OrderGrantedRefundLine'; id: Scalars['ID']['output']; @@ -17172,6 +16873,12 @@ export type OrderLine = Node & ObjectWithMetadata & { */ allocations?: Maybe>; digitalContentUrl?: Maybe; + /** + * List of applied discounts + * + * Added in Saleor 3.21. + */ + discounts?: Maybe>; /** ID of the order line. */ id: Scalars['ID']['output']; /** @@ -17182,53 +16889,29 @@ export type OrderLine = Node & ObjectWithMetadata & { * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ isGift?: Maybe; - /** - * Returns True, if the line unit price was overridden. - * - * Added in Saleor 3.14. - */ + /** Returns True, if the line unit price was overridden. */ isPriceOverridden?: Maybe; /** Whether the product variant requires shipping. */ isShippingRequired: Scalars['Boolean']['output']; - /** - * List of public metadata items. Can be accessed without permissions. - * - * Added in Saleor 3.5. - */ + /** List of public metadata items. Can be accessed without permissions. */ metadata: Array; /** * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.5. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.5. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; - /** - * List of private metadata items. Requires staff permissions to access. - * - * Added in Saleor 3.5. - */ + /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; /** * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.5. */ 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. - * - * Added in Saleor 3.5. - */ + /** 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; /** Name of the product in order line. */ productName: Scalars['String']['output']; @@ -17240,43 +16923,21 @@ export type OrderLine = Node & ObjectWithMetadata & { quantity: Scalars['Int']['output']; /** Number of variant items fulfilled. */ quantityFulfilled: Scalars['Int']['output']; - /** - * A quantity of items remaining to be fulfilled. - * - * Added in Saleor 3.1. - */ + /** A quantity of items remaining to be fulfilled. */ quantityToFulfill: Scalars['Int']['output']; - /** - * Denormalized sale ID, set when order line is created for a product variant that is on sale. - * - * Added in Saleor 3.14. - */ + /** Denormalized sale ID, set when order line is created for a product variant that is on sale. */ saleId?: Maybe; /** * Denormalized tax class of the product in this order line. * - * Added in Saleor 3.9. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */ taxClass?: Maybe; - /** - * Denormalized public metadata of the tax class. - * - * Added in Saleor 3.9. - */ + /** Denormalized public metadata of the tax class. */ taxClassMetadata: Array; - /** - * Denormalized name of the tax class. - * - * Added in Saleor 3.9. - */ + /** Denormalized name of the tax class. */ taxClassName?: Maybe; - /** - * Denormalized private metadata of the tax class. Requires staff permissions to access. - * - * Added in Saleor 3.9. - */ + /** Denormalized private metadata of the tax class. Requires staff permissions to access. */ taxClassPrivateMetadata: Array; /** Rate of tax applied on product variant. */ taxRate: Scalars['Float']['output']; @@ -17289,27 +16950,23 @@ export type OrderLine = Node & ObjectWithMetadata & { translatedVariantName: Scalars['String']['output']; /** Price of the order line without discounts. */ undiscountedTotalPrice: TaxedMoney; - /** Price of the single item in the order line without applied an order line discount. */ + /** Price of the single item in the order line without any discount applied. */ undiscountedUnitPrice: TaxedMoney; - /** The discount applied to the single order line. */ + /** 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 any discounts applied on a product in the order. */ + /** 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?: Maybe; - /** Type of the discount: fixed or percent */ + /** 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?: Maybe; - /** Value of the discount. Can store fixed value or percent value */ + /** 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: Scalars['PositiveDecimal']['output']; - /** Price of the single item in the order line. */ + /** Price of the single item in the order line with all the line-level discounts and order-level discount portions applied. */ unitPrice: TaxedMoney; /** A purchased product variant. Note: this field may be null if the variant has been removed from stock at all. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. */ variant?: Maybe; /** Name of the variant of product in order line. */ variantName: Scalars['String']['output']; - /** - * Voucher code that was used for this order line. - * - * Added in Saleor 3.14. - */ + /** Voucher code that was used for this order line. */ voucherCode?: Maybe; }; @@ -17345,19 +17002,9 @@ export type OrderLineThumbnailArgs = { }; export type OrderLineCreateInput = { - /** - * Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. - * - * Added in Saleor 3.6. - */ + /** 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. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** 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; /** Number of variant items ordered. */ quantity: Scalars['Int']['input']; @@ -17375,12 +17022,39 @@ export type OrderLineDelete = { errors: Array; /** A related order. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; /** An order line that was deleted. */ orderLine?: Maybe; }; +/** Represent the discount applied to order line. */ +export type OrderLineDiscount = { + __typename?: 'OrderLineDiscount'; + /** The ID of discount applied. */ + id: Scalars['ID']['output']; + /** The name of applied discount. */ + name?: Maybe; + /** + * Explanation for the applied discount. + * + * Requires one of the following permissions: MANAGE_ORDERS. + */ + reason?: Maybe; + /** The discount amount applied to the line item. */ + total: Money; + /** Translated name of the applied discount. */ + translatedName?: Maybe; + /** The type of applied discount: Sale, Voucher or Manual. */ + type: OrderDiscountType; + /** The discount amount applied to the single line unit. */ + unit: Money; + /** Value of the discount. Can store fixed value or percent value */ + value: Scalars['PositiveDecimal']['output']; + /** Type of the discount: fixed or percent */ + valueType: DiscountValueTypeEnum; +}; + /** * Remove discount applied to the order line. * @@ -17391,7 +17065,7 @@ export type OrderLineDiscountRemove = { errors: Array; /** Order which is related to line which has removed discount. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; /** Order line which has removed discount. */ orderLine?: Maybe; @@ -17407,7 +17081,7 @@ export type OrderLineDiscountUpdate = { errors: Array; /** Order which is related to the discounted line. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; /** Order line which has been discounted. */ orderLine?: Maybe; @@ -17428,13 +17102,13 @@ export type OrderLineUpdate = { errors: Array; /** Related order. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; orderLine?: Maybe; }; /** - * Create order lines for an order. + * Creates order lines for an order. * * Requires one of the following permissions: MANAGE_ORDERS. */ @@ -17443,7 +17117,7 @@ export type OrderLinesCreate = { errors: Array; /** Related order. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; /** List of added order lines. */ orderLines?: Maybe>; @@ -17459,15 +17133,11 @@ export type OrderMarkAsPaid = { errors: Array; /** Order marked as paid. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; -/** - * Event sent when order metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when order metadata is updated. */ export type OrderMetadataUpdated = Event & { __typename?: 'OrderMetadataUpdated'; /** Time of the event. */ @@ -17485,10 +17155,6 @@ export type OrderMetadataUpdated = Event & { /** * Adds note to the order. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ export type OrderNoteAdd = { @@ -17510,7 +17176,6 @@ export type OrderNoteAddError = { message?: Maybe; }; -/** An enumeration. */ export type OrderNoteAddErrorCode = | 'GRAPHQL_ERROR' | 'REQUIRED'; @@ -17523,10 +17188,6 @@ export type OrderNoteInput = { /** * Updates note of an order. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_ORDERS. */ export type OrderNoteUpdate = { @@ -17548,7 +17209,6 @@ export type OrderNoteUpdateError = { message?: Maybe; }; -/** An enumeration. */ export type OrderNoteUpdateErrorCode = | 'GRAPHQL_ERROR' | 'NOT_FOUND' @@ -17556,20 +17216,13 @@ export type OrderNoteUpdateErrorCode = export type OrderOrCheckout = Checkout | Order; -/** An enumeration. */ export type OrderOriginEnum = | 'BULK_CREATE' | 'CHECKOUT' | 'DRAFT' | 'REISSUE'; -/** - * Payment has been made. The order may be partially or fully paid. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Payment has been made. The order may be partially or fully paid. */ export type OrderPaid = Event & { __typename?: 'OrderPaid'; /** Time of the event. */ @@ -17603,7 +17256,7 @@ export type OrderRefund = { errors: Array; /** A refunded order. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -17632,13 +17285,7 @@ export type OrderRefundProductsInput = { orderLines?: InputMaybe>; }; -/** - * The order received a refund. The order may be partially or fully refunded. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** The order received a refund. The order may be partially or fully refunded. */ export type OrderRefunded = Event & { __typename?: 'OrderRefunded'; /** Time of the event. */ @@ -17687,33 +17334,23 @@ export type OrderReturnProductsInput = { /** Represents the channel-specific order settings. */ export type OrderSettings = { __typename?: 'OrderSettings'; - /** - * Determine if it is possible to place unpaid order by calling `checkoutComplete` mutation. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Determine if it is possible to place unpaid order by calling `checkoutComplete` mutation. */ allowUnpaidOrders: Scalars['Boolean']['output']; /** When disabled, all new orders from checkout will be marked as unconfirmed. When enabled orders from checkout will become unfulfilled immediately. */ automaticallyConfirmAllNewOrders: Scalars['Boolean']['output']; /** When enabled, all non-shippable gift card orders will be fulfilled automatically. */ automaticallyFulfillNonShippableGiftCard: Scalars['Boolean']['output']; - /** - * The time in days after expired orders will be deleted. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The time in days after expired orders will be deleted. */ deleteExpiredOrdersAfter: Scalars['Day']['output']; /** - * Expiration time in minutes. Default null - means do not expire any orders. + * Time in hours after which the draft order line price will be refreshed. * - * Added in Saleor 3.13. + * Added in Saleor 3.21. * * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ + draftOrderLinePriceFreezePeriod?: Maybe; + /** Expiration time in minutes. Default null - means do not expire any orders. */ expireOrdersAfter?: Maybe; /** * Determine if voucher applied on draft order should be count toward voucher usage. @@ -17727,12 +17364,17 @@ export type OrderSettings = { * Determine what strategy will be used to mark the order as paid. Based on the chosen option, the proper object will be created and attached to the order when it's manually marked as paid. * `PAYMENT_FLOW` - [default option] creates the `Payment` object. * `TRANSACTION_FLOW` - creates the `TransactionItem` object. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ markAsPaidStrategy: MarkAsPaidStrategyEnum; + /** + * 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. + */ + useLegacyLineDiscountPropagation: Scalars['Boolean']['output']; }; export type OrderSettingsError = { @@ -17745,38 +17387,27 @@ export type OrderSettingsError = { message?: Maybe; }; -/** An enumeration. */ export type OrderSettingsErrorCode = | 'INVALID'; export type OrderSettingsInput = { - /** - * Determine if it is possible to place unpaid order by calling `checkoutComplete` mutation. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Determine if it is possible to place unpaid order by calling `checkoutComplete` mutation. */ allowUnpaidOrders?: InputMaybe; /** When disabled, all new orders from checkout will be marked as unconfirmed. When enabled orders from checkout will become unfulfilled immediately. By default set to True */ automaticallyConfirmAllNewOrders?: InputMaybe; /** When enabled, all non-shippable gift card orders will be fulfilled automatically. By default set to True. */ automaticallyFulfillNonShippableGiftCard?: InputMaybe; - /** - * The time in days after expired orders will be deleted.Allowed range is from 1 to 120. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The time in days after expired orders will be deleted.Allowed range is from 1 to 120. */ deleteExpiredOrdersAfter?: InputMaybe; /** - * Expiration time in minutes. Default null - means do not expire any orders. Enter 0 or null to disable. + * Time in hours after which the draft order line price will be refreshed. Default value is 24 hours. Enter 0 or null to disable. * - * Added in Saleor 3.13. + * Added in Saleor 3.21. * * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ + draftOrderLinePriceFreezePeriod?: InputMaybe; + /** Expiration time in minutes. Default null - means do not expire any orders. Enter 0 or null to disable. */ expireOrdersAfter?: InputMaybe; /** * Specify whether a coupon applied to draft orders will count toward voucher usage. @@ -17792,12 +17423,17 @@ export type OrderSettingsInput = { * Determine what strategy will be used to mark the order as paid. Based on the chosen option, the proper object will be created and attached to the order when it's manually marked as paid. * `PAYMENT_FLOW` - [default option] creates the `Payment` object. * `TRANSACTION_FLOW` - creates the `TransactionItem` object. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ markAsPaidStrategy?: InputMaybe; + /** + * 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. + */ + useLegacyLineDiscountPropagation?: InputMaybe; }; /** @@ -17810,7 +17446,7 @@ export type OrderSettingsUpdate = { errors: Array; /** Order settings. */ orderSettings?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderSettingsErrors: Array; }; @@ -17822,30 +17458,28 @@ export type OrderSettingsUpdateInput = { }; export type OrderSortField = - /** - * Sort orders by creation date. - * - * DEPRECATED: this field will be removed in Saleor 4.0. - */ + /** Sort orders by creation date. */ | 'CREATED_AT' - /** - * Sort orders by creation date. - * - * DEPRECATED: this field will be removed in Saleor 4.0. - */ + /** Sort orders by creation date */ | 'CREATION_DATE' /** Sort orders by customer. */ | 'CUSTOMER' /** Sort orders by fulfillment status. */ | 'FULFILLMENT_STATUS' - /** Sort orders by last modified at. */ + /** Sort orders by last modified date. */ | 'LAST_MODIFIED_AT' /** Sort orders by number. */ | 'NUMBER' - /** Sort orders by payment. */ + /** Sort orders by payment status. */ | 'PAYMENT' /** Sort orders by rank. Note: This option is available only with the `search` filter. */ - | 'RANK'; + | 'RANK' + /** + * Sort orders by order status. + * + * Added in Saleor 3.22. + */ + | 'STATUS'; export type OrderSortingInput = { /** Specifies the direction in which to sort orders. */ @@ -17854,7 +17488,6 @@ export type OrderSortingInput = { field: OrderSortField; }; -/** An enumeration. */ export type OrderStatus = | 'CANCELED' | 'DRAFT' @@ -17866,6 +17499,14 @@ export type OrderStatus = | 'UNCONFIRMED' | 'UNFULFILLED'; +/** Filter by order status. */ +export type OrderStatusEnumFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value included in. */ + oneOf?: InputMaybe>; +}; + export type OrderStatusFilter = | 'CANCELED' | 'FULFILLED' @@ -17884,19 +17525,37 @@ export type OrderUpdate = { __typename?: 'OrderUpdate'; errors: Array; order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; export type OrderUpdateInput = { /** Billing address of the customer. */ billingAddress?: InputMaybe; + /** External ID of this order. */ + externalReference?: InputMaybe; /** - * External ID of this order. + * Order language code. * - * Added in Saleor 3.10. + * Added in Saleor 3.21. */ - externalReference?: InputMaybe; + languageCode?: InputMaybe; + /** + * Order public metadata. + * + * Added in Saleor 3.21.Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ + metadata?: InputMaybe>; + /** + * Order private metadata. + * + * Added in Saleor 3.21.Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ + privateMetadata?: InputMaybe>; /** Shipping address of the customer. */ shippingAddress?: InputMaybe; /** Email address of the customer. */ @@ -17913,7 +17572,7 @@ export type OrderUpdateShipping = { errors: Array; /** Order with updated shipping method. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; @@ -17922,11 +17581,7 @@ export type OrderUpdateShippingInput = { shippingMethod?: InputMaybe; }; -/** - * Event sent when order is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when order is updated. */ export type OrderUpdated = Event & { __typename?: 'OrderUpdated'; /** Time of the event. */ @@ -17951,14 +17606,116 @@ export type OrderVoid = { errors: Array; /** A voided order. */ order?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ orderErrors: Array; }; +export type OrderWhereInput = { + /** List of conditions that must be met. */ + AND?: InputMaybe>; + /** A list of conditions of which at least one must be met. */ + OR?: InputMaybe>; + /** Filter by authorize status. */ + authorizeStatus?: InputMaybe; + /** Filter by billing address of the order. */ + billingAddress?: InputMaybe; + /** Filter by channel. */ + channelId?: InputMaybe; + /** Filter by charge status. */ + chargeStatus?: InputMaybe; + /** Filter by checkout id. */ + checkoutId?: InputMaybe; + /** Filter by checkout token. */ + checkoutToken?: InputMaybe; + /** Filter order by created at date. */ + createdAt?: InputMaybe; + /** Filter by order events. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. */ + events?: InputMaybe>; + /** Filter by fulfillment data associated with the order. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. */ + fulfillments?: InputMaybe>; + /** Filter by whether the order has any fulfillments. */ + hasFulfillments?: InputMaybe; + /** Filter by whether the order has any invoices. */ + hasInvoices?: InputMaybe; + ids?: InputMaybe>; + /** Filter by invoice data associated with the order. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. */ + invoices?: InputMaybe>; + /** Filter by whether the order uses the click and collect delivery method. */ + isClickAndCollect?: InputMaybe; + /** Filter based on whether the order includes a gift card purchase. */ + isGiftCardBought?: InputMaybe; + /** Filter based on whether a gift card was used in the order. */ + isGiftCardUsed?: InputMaybe; + /** Filter by line items associated with the order. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. */ + lines?: InputMaybe>; + /** Filter by number of lines in the order. */ + linesCount?: InputMaybe; + /** Filter by metadata fields. */ + metadata?: InputMaybe; + /** Filter by order number. */ + number?: InputMaybe; + /** Filter by the product type of related order lines. */ + productTypeId?: InputMaybe; + /** Filter by shipping address of the order. */ + shippingAddress?: InputMaybe; + /** Filter by order status. */ + status?: InputMaybe; + /** Filter by total gross amount of the order. */ + totalGross?: InputMaybe; + /** Filter by total net amount of the order. */ + totalNet?: InputMaybe; + /** Filter by transaction data associated with the order. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. */ + transactions?: InputMaybe>; + /** Filter order by updated at date. */ + updatedAt?: InputMaybe; + /** Filter by user. */ + user?: InputMaybe; + /** Filter by user email. */ + userEmail?: InputMaybe; + /** Filter by voucher code used in the order. */ + voucherCode?: InputMaybe; +}; + +/** + * Represents a payment method used for a transaction. + * + * Added in Saleor 3.22. + */ +export type OtherPaymentMethodDetails = PaymentMethodDetails & { + __typename?: 'OtherPaymentMethodDetails'; + /** Name of the payment method. */ + name: Scalars['String']['output']; +}; + +export type OtherPaymentMethodDetailsInput = { + /** Name of the payment method used for the transaction. */ + name: Scalars['String']['input']; +}; + /** A static page that can be manually added by a shop operator through the dashboard. */ -export type Page = Node & ObjectWithMetadata & { +export type Page = Node & ObjectWithAttributes & ObjectWithMetadata & { __typename?: 'Page'; - /** List of attributes assigned to this product. */ + /** + * Get a single attribute attached to page by attribute slug. + * + * Added in Saleor 3.22. + */ + assignedAttribute?: Maybe; + /** + * List of attributes assigned to this page. + * + * Added in Saleor 3.22. + */ + assignedAttributes: Array; + /** + * Get a single attribute attached to page by attribute slug. + * @deprecated Use `assignedAttribute` field instead. + */ + attribute?: Maybe; + /** + * List of attributes assigned to this page. + * @deprecated Use `assignedAttributes` field instead. + */ attributes: Array; /** * Content of the page. @@ -17970,7 +17727,7 @@ export type Page = Node & ObjectWithMetadata & { * Content of the page. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `content` field instead. + * @deprecated Use the `content` field instead. */ contentJson: Scalars['JSONString']['output']; /** Date and time at which page was created. */ @@ -17985,15 +17742,9 @@ export type Page = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Determines the type of page */ pageType: PageType; @@ -18003,23 +17754,13 @@ export type Page = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; - /** @deprecated This field will be removed in Saleor 4.0. Use the `publishedAt` field to fetch the publication date. */ + /** @deprecated Use the `publishedAt` field to fetch the publication date. */ publicationDate?: Maybe; - /** - * The page publication date. - * - * Added in Saleor 3.3. - */ + /** The page publication date. */ publishedAt?: Maybe; /** Description of the page for SEO. */ seoDescription?: Maybe; @@ -18034,6 +17775,24 @@ export type Page = Node & ObjectWithMetadata & { }; +/** A static page that can be manually added by a shop operator through the dashboard. */ +export type PageAssignedAttributeArgs = { + slug: Scalars['String']['input']; +}; + + +/** A static page that can be manually added by a shop operator through the dashboard. */ +export type PageAssignedAttributesArgs = { + limit?: InputMaybe; +}; + + +/** A static page that can be manually added by a shop operator through the dashboard. */ +export type PageAttributeArgs = { + slug: Scalars['String']['input']; +}; + + /** A static page that can be manually added by a shop operator through the dashboard. */ export type PageMetafieldArgs = { key: Scalars['String']['input']; @@ -18071,7 +17830,7 @@ export type PageTranslationArgs = { export type PageAttributeAssign = { __typename?: 'PageAttributeAssign'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; /** The updated page type. */ pageType?: Maybe; @@ -18085,7 +17844,7 @@ export type PageAttributeAssign = { export type PageAttributeUnassign = { __typename?: 'PageAttributeUnassign'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; /** The updated page type. */ pageType?: Maybe; @@ -18101,7 +17860,7 @@ export type PageBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; }; @@ -18115,7 +17874,7 @@ export type PageBulkPublish = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; }; @@ -18145,7 +17904,7 @@ export type PageCreate = { __typename?: 'PageCreate'; errors: Array; page?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; }; @@ -18164,15 +17923,10 @@ export type PageCreateInput = { pageType: Scalars['ID']['input']; /** * Publication date. ISO 8601 standard. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead. + * @deprecated Use `publishedAt` field instead. */ publicationDate?: InputMaybe; - /** - * Publication date time. ISO 8601 standard. - * - * Added in Saleor 3.3. - */ + /** Publication date time. ISO 8601 standard. */ publishedAt?: InputMaybe; /** Search engine optimization fields. */ seo?: InputMaybe; @@ -18182,11 +17936,7 @@ export type PageCreateInput = { title?: InputMaybe; }; -/** - * Event sent when new page is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new page is created. */ export type PageCreated = Event & { __typename?: 'PageCreated'; /** Time of the event. */ @@ -18210,15 +17960,11 @@ export type PageDelete = { __typename?: 'PageDelete'; errors: Array; page?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; }; -/** - * Event sent when page is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when page is deleted. */ export type PageDeleted = Event & { __typename?: 'PageDeleted'; /** Time of the event. */ @@ -18247,7 +17993,6 @@ export type PageError = { values?: Maybe>; }; -/** An enumeration. */ export type PageErrorCode = | 'ATTRIBUTE_ALREADY_ASSIGNED' | 'DUPLICATED_INPUT_ITEM' @@ -18291,15 +18036,10 @@ export type PageInput = { isPublished?: InputMaybe; /** * Publication date. ISO 8601 standard. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead. + * @deprecated Use `publishedAt` field instead. */ publicationDate?: InputMaybe; - /** - * Publication date time. ISO 8601 standard. - * - * Added in Saleor 3.3. - */ + /** Publication date time. ISO 8601 standard. */ publishedAt?: InputMaybe; /** Search engine optimization fields. */ seo?: InputMaybe; @@ -18319,34 +18059,18 @@ export type PageReorderAttributeValues = { errors: Array; /** Page from which attribute values are reordered. */ page?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; }; export type PageSortField = - /** - * Sort pages by creation date. - * - * DEPRECATED: this field will be removed in Saleor 4.0. - */ + /** Sort pages by creation date. */ | 'CREATED_AT' - /** - * Sort pages by creation date. - * - * DEPRECATED: this field will be removed in Saleor 4.0. - */ + /** Sort pages by creation date. */ | 'CREATION_DATE' - /** - * Sort pages by publication date. - * - * DEPRECATED: this field will be removed in Saleor 4.0. - */ + /** Sort pages by publication date. */ | 'PUBLICATION_DATE' - /** - * Sort pages by publication date. - * - * DEPRECATED: this field will be removed in Saleor 4.0. - */ + /** Sort pages by publication date. */ | 'PUBLISHED_AT' /** Sort pages by slug. */ | 'SLUG' @@ -18377,26 +18101,28 @@ export type PageTranslatableContent = Node & { * Content of the page. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `content` field instead. + * @deprecated Use the `content` field instead. */ contentJson?: Maybe; /** The ID of the page translatable content. */ id: Scalars['ID']['output']; /** * A static page that can be manually added by a shop operator through the dashboard. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ page?: Maybe; - /** - * The ID of the page to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the page to translate. */ pageId: Scalars['ID']['output']; /** SEO description to translate. */ seoDescription?: Maybe; /** SEO title to translate. */ seoTitle?: Maybe; + /** + * Slug to translate. + * + * Added in Saleor 3.21. + */ + slug?: Maybe; /** Page title to translate. */ title: Scalars['String']['output']; /** Returns translated page fields for the given language code. */ @@ -18418,7 +18144,7 @@ export type PageTranslate = { __typename?: 'PageTranslate'; errors: Array; page?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; @@ -18435,7 +18161,7 @@ export type PageTranslation = Node & { * Translated description of the page. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `content` field instead. + * @deprecated Use the `content` field instead. */ contentJson?: Maybe; /** The ID of the page translation. */ @@ -18446,13 +18172,15 @@ export type PageTranslation = Node & { seoDescription?: Maybe; /** Translated SEO title. */ seoTitle?: Maybe; - /** Translated page title. */ - title?: Maybe; /** - * Represents the page fields to translate. + * Translated page slug. * - * Added in Saleor 3.14. + * Added in Saleor 3.21. */ + slug?: Maybe; + /** Translated page title. */ + title?: Maybe; + /** Represents the page fields to translate. */ translatableContent?: Maybe; }; @@ -18465,6 +18193,7 @@ export type PageTranslationInput = { content?: InputMaybe; seoDescription?: InputMaybe; seoTitle?: InputMaybe; + slug?: InputMaybe; title?: InputMaybe; }; @@ -18493,15 +18222,9 @@ export type PageType = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Name of the page type. */ name: Scalars['String']['output']; @@ -18511,15 +18234,9 @@ export type PageType = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** Slug of the page type. */ slug: Scalars['String']['output']; @@ -18533,6 +18250,7 @@ export type PageTypeAvailableAttributesArgs = { filter?: InputMaybe; first?: InputMaybe; last?: InputMaybe; + search?: InputMaybe; where?: InputMaybe; }; @@ -18561,7 +18279,7 @@ export type PageTypePrivateMetafieldsArgs = { }; /** - * Delete page types. + * Deletes page types. * * Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. */ @@ -18570,7 +18288,7 @@ export type PageTypeBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; }; @@ -18592,14 +18310,14 @@ export type PageTypeCountableEdge = { }; /** - * Create a new page type. + * Creates a new page type. * * Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. */ export type PageTypeCreate = { __typename?: 'PageTypeCreate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; pageType?: Maybe; }; @@ -18613,11 +18331,7 @@ export type PageTypeCreateInput = { slug?: InputMaybe; }; -/** - * Event sent when new page type is created. - * - * Added in Saleor 3.5. - */ +/** Event sent when new page type is created. */ export type PageTypeCreated = Event & { __typename?: 'PageTypeCreated'; /** Time of the event. */ @@ -18633,23 +18347,19 @@ export type PageTypeCreated = Event & { }; /** - * Delete a page type. + * Deletes a page type. * * Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. */ export type PageTypeDelete = { __typename?: 'PageTypeDelete'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; pageType?: Maybe; }; -/** - * Event sent when page type is deleted. - * - * Added in Saleor 3.5. - */ +/** Event sent when page type is deleted. */ export type PageTypeDeleted = Event & { __typename?: 'PageTypeDeleted'; /** Time of the event. */ @@ -18677,7 +18387,7 @@ export type PageTypeFilterInput = { export type PageTypeReorderAttributes = { __typename?: 'PageTypeReorderAttributes'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; /** Page type from which attributes are reordered. */ pageType?: Maybe; @@ -18697,14 +18407,14 @@ export type PageTypeSortingInput = { }; /** - * Update page type. + * Updates page type. * * Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. */ export type PageTypeUpdate = { __typename?: 'PageTypeUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; pageType?: Maybe; }; @@ -18720,11 +18430,7 @@ export type PageTypeUpdateInput = { slug?: InputMaybe; }; -/** - * Event sent when page type is updated. - * - * Added in Saleor 3.5. - */ +/** Event sent when page type is updated. */ export type PageTypeUpdated = Event & { __typename?: 'PageTypeUpdated'; /** Time of the event. */ @@ -18748,15 +18454,11 @@ export type PageUpdate = { __typename?: 'PageUpdate'; errors: Array; page?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pageErrors: Array; }; -/** - * Event sent when page is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when page is updated. */ export type PageUpdated = Event & { __typename?: 'PageUpdated'; /** Time of the event. */ @@ -18771,6 +18473,22 @@ export type PageUpdated = Event & { version?: Maybe; }; +export type PageWhereInput = { + /** List of conditions that must be met. */ + AND?: InputMaybe>; + /** A list of conditions of which at least one must be met. */ + OR?: InputMaybe>; + /** Filter by attributes associated with the page. */ + attributes?: InputMaybe>; + ids?: InputMaybe>; + /** Filter by metadata fields. */ + metadata?: InputMaybe; + /** Filter by page type. */ + pageType?: InputMaybe; + /** Filter by page slug. */ + slug?: InputMaybe; +}; + /** * Change the password of the logged in user. * @@ -18778,7 +18496,7 @@ export type PageUpdated = Event & { */ export type PasswordChange = { __typename?: 'PasswordChange'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** A user instance with a new password. */ @@ -18834,25 +18552,15 @@ export type Payment = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Date and time at which payment was modified. */ modified: Scalars['DateTime']['output']; /** Order associated with a payment. */ order?: Maybe; - /** - * Informs whether this is a partial payment. - * - * Added in Saleor 3.14. - */ + /** Informs whether this is a partial payment. */ partial: Scalars['Boolean']['output']; /** Type of method used for payment. */ paymentMethodType: Scalars['String']['output']; @@ -18862,21 +18570,11 @@ export type Payment = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; - /** - * PSP reference of the payment. - * - * Added in Saleor 3.14. - */ + /** PSP reference of the payment. */ pspReference?: Maybe; /** Unique token associated with a payment. */ token: Scalars['String']['output']; @@ -18914,11 +18612,7 @@ export type PaymentPrivateMetafieldsArgs = { keys?: InputMaybe>; }; -/** - * Authorize payment. - * - * Added in Saleor 3.6. - */ +/** Authorize payment. */ export type PaymentAuthorize = Event & { __typename?: 'PaymentAuthorize'; /** Time of the event. */ @@ -18943,15 +18637,11 @@ export type PaymentCapture = { errors: Array; /** Updated payment. */ payment?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ paymentErrors: Array; }; -/** - * Capture payment. - * - * Added in Saleor 3.6. - */ +/** Capture payment. */ export type PaymentCaptureEvent = Event & { __typename?: 'PaymentCaptureEvent'; /** Time of the event. */ @@ -18966,7 +18656,6 @@ export type PaymentCaptureEvent = Event & { version?: Maybe; }; -/** An enumeration. */ export type PaymentChargeStatusEnum = | 'CANCELLED' | 'FULLY_CHARGED' @@ -18983,7 +18672,7 @@ export type PaymentCheckBalance = { /** Response from the gateway. */ data?: Maybe; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ paymentErrors: Array; }; @@ -18998,11 +18687,7 @@ export type PaymentCheckBalanceInput = { method: Scalars['String']['input']; }; -/** - * Confirm payment. - * - * Added in Saleor 3.6. - */ +/** Confirm payment. */ export type PaymentConfirmEvent = Event & { __typename?: 'PaymentConfirmEvent'; /** Time of the event. */ @@ -19046,13 +18731,13 @@ export type PaymentError = { variants?: Maybe>; }; -/** An enumeration. */ export type PaymentErrorCode = | 'BALANCE_CHECK_ERROR' | 'BILLING_ADDRESS_NOT_SET' | 'CHANNEL_INACTIVE' | 'CHECKOUT_COMPLETION_IN_PROGRESS' | 'CHECKOUT_EMAIL_NOT_SET' + | 'CHECKOUT_HAS_TRANSACTION' | 'GRAPHQL_ERROR' | 'INVALID' | 'INVALID_SHIPPING_METHOD' @@ -19069,11 +18754,7 @@ export type PaymentErrorCode = export type PaymentFilterInput = { checkouts?: InputMaybe>; - /** - * Filter by ids. - * - * Added in Saleor 3.8. - */ + /** Filter by ids. */ ids?: InputMaybe>; }; @@ -19109,19 +18790,12 @@ export type PaymentGatewayConfigError = { message?: Maybe; }; -/** An enumeration. */ export type PaymentGatewayConfigErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' | 'NOT_FOUND'; -/** - * 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. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** 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. */ export type PaymentGatewayInitialize = { __typename?: 'PaymentGatewayInitialize'; errors: Array; @@ -19139,19 +18813,12 @@ export type PaymentGatewayInitializeError = { message?: Maybe; }; -/** An enumeration. */ export type PaymentGatewayInitializeErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' | 'NOT_FOUND'; -/** - * Event sent when user wants to initialize the payment gateway. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when user wants to initialize the payment gateway. */ export type PaymentGatewayInitializeSession = Event & { __typename?: 'PaymentGatewayInitializeSession'; /** Amount requested for initializing the payment gateway. */ @@ -19173,10 +18840,6 @@ export type PaymentGatewayInitializeSession = Event & { /** * Initializes payment gateway for tokenizing payment method session. * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_USER. * * Triggers the following webhook events: @@ -19201,7 +18864,6 @@ export type PaymentGatewayInitializeTokenizationError = { message?: Maybe; }; -/** An enumeration. */ export type PaymentGatewayInitializeTokenizationErrorCode = | 'CHANNEL_INACTIVE' | 'GATEWAY_ERROR' @@ -19222,13 +18884,7 @@ export type PaymentGatewayInitializeTokenizationResult = | 'FAILED_TO_INITIALIZE' | 'SUCCESSFULLY_INITIALIZED'; -/** - * Event sent to initialize a new session in payment gateway to store the payment method. - * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** 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. */ @@ -19260,7 +18916,7 @@ export type PaymentInitialize = { errors: Array; /** Payment that was initialized. */ initializedPayment?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ paymentErrors: Array; }; @@ -19281,28 +18937,20 @@ export type PaymentInput = { /** A gateway to use with that payment. */ gateway: Scalars['String']['input']; /** - * User public metadata. + * User public metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.1. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** URL of a storefront view where user should be redirected after requiring additional actions. Payment with additional actions will not be finished if this field is not provided. */ returnUrl?: InputMaybe; - /** - * Payment store type. - * - * Added in Saleor 3.1. - */ + /** Payment store type. */ storePaymentMethod?: InputMaybe; /** Client-side generated payment token, representing customer's billing data in a secure manner. */ token?: InputMaybe; }; -/** - * List payment gateways. - * - * Added in Saleor 3.6. - */ +/** List payment gateways. */ export type PaymentListGateways = Event & { __typename?: 'PaymentListGateways'; /** The checkout the event relates to. */ @@ -19318,11 +18966,41 @@ export type PaymentListGateways = Event & { }; /** - * Tokenize payment method. + * Represents a payment method used for a transaction. * - * Added in Saleor 3.16. + * Added in Saleor 3.22. + */ +export type PaymentMethodDetails = { + /** Name of the payment method. */ + name: Scalars['String']['output']; +}; + +export type PaymentMethodDetailsCardFilterInput = { + /** Filter by payment method brand used to pay for the order. */ + brand?: InputMaybe; +}; + +export type PaymentMethodDetailsFilterInput = { + /** Filter by card details used to pay for the order. Skips `type` filter if provided. */ + card?: InputMaybe; + /** Filter by payment method type used to pay for the order. */ + type?: InputMaybe; +}; + +/** + * Details of the payment method used for the transaction. One of `card` or `other` is required. * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Added in Saleor 3.22. + */ +export type PaymentMethodDetailsInput = { + /** Details of the card payment method used for the transaction. */ + card?: InputMaybe; + /** Details of the non-card payment method used for this transaction. */ + other?: InputMaybe; +}; + +/** + * Tokenize payment method. * * Requires one of the following permissions: AUTHENTICATED_USER. * @@ -19350,7 +19028,6 @@ export type PaymentMethodInitializeTokenizationError = { message?: Maybe; }; -/** An enumeration. */ export type PaymentMethodInitializeTokenizationErrorCode = | 'CHANNEL_INACTIVE' | 'GATEWAY_ERROR' @@ -19358,13 +19035,7 @@ export type PaymentMethodInitializeTokenizationErrorCode = | 'INVALID' | 'NOT_FOUND'; -/** - * Event sent when user requests a tokenization of payment method. - * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when user requests a tokenization of payment method. */ export type PaymentMethodInitializeTokenizationSession = Event & { __typename?: 'PaymentMethodInitializeTokenizationSession'; /** Channel related to the requested action. */ @@ -19388,10 +19059,6 @@ export type PaymentMethodInitializeTokenizationSession = Event & { /** * Tokenize payment method. * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_USER. * * Triggers the following webhook events: @@ -19418,7 +19085,6 @@ export type PaymentMethodProcessTokenizationError = { message?: Maybe; }; -/** An enumeration. */ export type PaymentMethodProcessTokenizationErrorCode = | 'CHANNEL_INACTIVE' | 'GATEWAY_ERROR' @@ -19426,13 +19092,7 @@ export type PaymentMethodProcessTokenizationErrorCode = | 'INVALID' | 'NOT_FOUND'; -/** - * Event sent when user continues a tokenization of payment method. - * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when user continues a tokenization of payment method. */ export type PaymentMethodProcessTokenizationSession = Event & { __typename?: 'PaymentMethodProcessTokenizationSession'; /** Channel related to the requested action. */ @@ -19481,10 +19141,24 @@ export type PaymentMethodTokenizationResult = | 'SUCCESSFULLY_TOKENIZED'; /** - * Process payment. + * Represents possible payment method types. * - * Added in Saleor 3.6. + * 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' + | 'OTHER'; + +export type PaymentMethodTypeEnumFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value included in. */ + oneOf?: InputMaybe>; +}; + +/** Process payment. */ export type PaymentProcessEvent = Event & { __typename?: 'PaymentProcessEvent'; /** Time of the event. */ @@ -19509,15 +19183,11 @@ export type PaymentRefund = { errors: Array; /** Updated payment. */ payment?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ paymentErrors: Array; }; -/** - * Refund payment. - * - * Added in Saleor 3.6. - */ +/** Refund payment. */ export type PaymentRefundEvent = Event & { __typename?: 'PaymentRefundEvent'; /** Time of the event. */ @@ -19536,24 +19206,48 @@ export type PaymentRefundEvent = Event & { export type PaymentSettings = { __typename?: '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. + * 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.16. + * Added in Saleor 3.20. + */ + checkoutReleaseFundsCutOffDate?: Maybe; + /** + * The time in hours after which funds for expired checkouts will be released. * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Added in Saleor 3.20. */ + checkoutTtlBeforeReleasingFunds?: Maybe; + /** 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. + * + * Added in Saleor 3.20. + */ + releaseFundsForExpiredCheckouts?: Maybe; }; export type 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. + * 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.16. + * Added in Saleor 3.20. + */ + checkoutReleaseFundsCutOffDate?: InputMaybe; + /** + * The time in hours after which funds for expired checkouts will be released. * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Added in Saleor 3.20. */ + checkoutTtlBeforeReleasingFunds?: InputMaybe; + /** 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?: InputMaybe; + /** + * Determine if the funds for expired checkouts should be released automatically. + * + * Added in Saleor 3.20. + */ + releaseFundsForExpiredCheckouts?: InputMaybe; }; /** Represents a payment source stored for user in payment gateway, such as credit card. */ @@ -19566,8 +19260,6 @@ export type PaymentSource = { /** * List of public metadata items. * - * Added in Saleor 3.1. - * * Can be accessed without permissions. */ metadata: Array; @@ -19585,15 +19277,11 @@ export type PaymentVoid = { errors: Array; /** Updated payment. */ payment?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ paymentErrors: Array; }; -/** - * Void payment. - * - * Added in Saleor 3.6. - */ +/** Void payment. */ export type PaymentVoidEvent = Event & { __typename?: 'PaymentVoidEvent'; /** Time of the event. */ @@ -19617,7 +19305,6 @@ export type Permission = { name: Scalars['String']['output']; }; -/** An enumeration. */ export type PermissionEnum = | 'HANDLE_CHECKOUTS' | 'HANDLE_PAYMENTS' @@ -19656,18 +19343,12 @@ export type PermissionGroupCreate = { __typename?: 'PermissionGroupCreate'; errors: Array; group?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ permissionGroupErrors: Array; }; export type PermissionGroupCreateInput = { - /** - * List of channels to assign to this group. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of channels to assign to this group. */ addChannels?: InputMaybe>; /** List of permission code names to assign to this group. */ addPermissions?: InputMaybe>; @@ -19675,21 +19356,11 @@ export type PermissionGroupCreateInput = { addUsers?: InputMaybe>; /** Group name. */ name: Scalars['String']['input']; - /** - * Determine if the group has restricted access to channels. DEFAULT: False - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Determine if the group has restricted access to channels. DEFAULT: False */ restrictedAccessToChannels?: InputMaybe; }; -/** - * Event sent when new permission group is created. - * - * Added in Saleor 3.6. - */ +/** Event sent when new permission group is created. */ export type PermissionGroupCreated = Event & { __typename?: 'PermissionGroupCreated'; /** Time of the event. */ @@ -19716,15 +19387,11 @@ export type PermissionGroupDelete = { __typename?: 'PermissionGroupDelete'; errors: Array; group?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ permissionGroupErrors: Array; }; -/** - * Event sent when permission group is deleted. - * - * Added in Saleor 3.6. - */ +/** Event sent when permission group is deleted. */ export type PermissionGroupDeleted = Event & { __typename?: 'PermissionGroupDeleted'; /** Time of the event. */ @@ -19755,7 +19422,6 @@ export type PermissionGroupError = { users?: Maybe>; }; -/** An enumeration. */ export type PermissionGroupErrorCode = | 'ASSIGN_NON_STAFF_MEMBER' | 'CANNOT_REMOVE_FROM_LAST_GROUP' @@ -19796,18 +19462,12 @@ export type PermissionGroupUpdate = { __typename?: 'PermissionGroupUpdate'; errors: Array; group?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ permissionGroupErrors: Array; }; export type PermissionGroupUpdateInput = { - /** - * List of channels to assign to this group. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of channels to assign to this group. */ addChannels?: InputMaybe>; /** List of permission code names to assign to this group. */ addPermissions?: InputMaybe>; @@ -19815,33 +19475,17 @@ export type PermissionGroupUpdateInput = { addUsers?: InputMaybe>; /** Group name. */ name?: InputMaybe; - /** - * List of channels to unassign from this group. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** List of channels to unassign from this group. */ removeChannels?: InputMaybe>; /** List of permission code names to unassign from this group. */ removePermissions?: InputMaybe>; /** List of users to unassign from this group. */ removeUsers?: InputMaybe>; - /** - * Determine if the group has restricted access to channels. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Determine if the group has restricted access to channels. */ restrictedAccessToChannels?: InputMaybe; }; -/** - * Event sent when permission group is updated. - * - * Added in Saleor 3.6. - */ +/** Event sent when permission group is updated. */ export type PermissionGroupUpdated = Event & { __typename?: 'PermissionGroupUpdated'; /** Time of the event. */ @@ -19913,7 +19557,6 @@ export type PluginError = { message?: Maybe; }; -/** An enumeration. */ export type PluginErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' @@ -19953,7 +19596,7 @@ export type PluginUpdate = { __typename?: 'PluginUpdate'; errors: Array; plugin?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ pluginsErrors: Array; }; @@ -19964,7 +19607,6 @@ export type PluginUpdateInput = { configuration?: InputMaybe>; }; -/** An enumeration. */ export type PostalCodeRuleInclusionTypeEnum = | 'EXCLUDE' | 'INCLUDE'; @@ -20004,6 +19646,13 @@ export type PreorderThreshold = { soldUnits: Scalars['Int']['output']; }; +export type PriceFilterInput = { + /** The amount of the price to filter by. */ + amount: DecimalFilterInput; + /** The currency of the price to filter by. */ + currency?: InputMaybe; +}; + export type PriceInput = { /** Amount of money. */ amount: Scalars['PositiveDecimal']['input']; @@ -20019,19 +19668,33 @@ export type PriceRangeInput = { }; /** Represents an individual item for sale in the storefront. */ -export type Product = Node & ObjectWithMetadata & { +export type Product = Node & ObjectWithAttributes & ObjectWithMetadata & { __typename?: 'Product'; /** * Get a single attribute attached to product by attribute slug. * - * Added in Saleor 3.9. + * Added in Saleor 3.22. + */ + assignedAttribute?: Maybe; + /** + * List of attributes assigned to this product. + * + * Added in Saleor 3.22. + */ + assignedAttributes: Array; + /** + * Get a single attribute attached to product by attribute slug. + * @deprecated Use the `assignedAttribute` field instead. */ attribute?: Maybe; - /** List of attributes assigned to this product. */ + /** + * List of attributes assigned to this product. + * @deprecated Use the `assignedAttributes` field instead. + */ attributes: Array; /** * Date when product is available for purchase. - * @deprecated This field will be removed in Saleor 4.0. Use the `availableForPurchaseAt` field to fetch the available for purchase date. + * @deprecated Use the `availableForPurchaseAt` field to fetch the available for purchase date. */ availableForPurchase?: Maybe; /** Date when product is available for purchase. */ @@ -20045,7 +19708,7 @@ export type Product = Node & ObjectWithMetadata & { * Requires one of the following permissions: MANAGE_PRODUCTS. */ channelListings?: Maybe>; - /** @deprecated This field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` field to determine whether tax collection is enabled. */ + /** @deprecated Use `Channel.taxConfiguration` field to determine whether tax collection is enabled. */ chargeTaxes: Scalars['Boolean']['output']; /** List of collections for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. */ collections?: Maybe>; @@ -20063,25 +19726,21 @@ export type Product = Node & ObjectWithMetadata & { * Description of the product. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `description` field instead. + * @deprecated Use the `description` field instead. */ descriptionJson?: Maybe; - /** - * External ID of this product. - * - * Added in Saleor 3.10. - */ + /** External ID of this product. */ externalReference?: Maybe; /** The ID of the product. */ id: Scalars['ID']['output']; /** * Get a single product image by ID. - * @deprecated This field will be removed in Saleor 4.0. Use the `mediaById` field instead. + * @deprecated Use the `mediaById` field instead. */ imageById?: Maybe; /** * List of images for the product. - * @deprecated This field will be removed in Saleor 4.0. Use the `media` field instead. + * @deprecated Use the `media` field instead. */ images?: Maybe>; /** Whether the product is in stock, set as available for purchase in the given channel, and published. */ @@ -20098,15 +19757,9 @@ export type Product = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** SEO description of the product. */ name: Scalars['String']['output']; @@ -20118,18 +19771,18 @@ export type Product = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** Type of the product. */ productType: ProductType; + /** + * List of variants for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. + * + * Added in Saleor 3.21. + */ + productVariants?: Maybe; /** Rating of the product. */ rating?: Maybe; /** SEO description of the product. */ @@ -20146,7 +19799,7 @@ export type Product = Node & ObjectWithMetadata & { taxClass?: Maybe; /** * A type of tax. Assigned by enabled tax gateway - * @deprecated This field will be removed in Saleor 4.0. Use `taxClass` field instead. + * @deprecated Use `taxClass` field instead. */ taxType?: Maybe; /** Thumbnail of the product. */ @@ -20157,18 +19810,31 @@ export type Product = Node & ObjectWithMetadata & { updatedAt: Scalars['DateTime']['output']; /** * Get a single variant by SKU or ID. - * - * Added in Saleor 3.9. - * @deprecated This field will be removed in Saleor 4.0. Use top-level `variant` query. + * @deprecated Use top-level `variant` query. */ variant?: Maybe; - /** List of variants for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. */ + /** + * List of variants for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. + * @deprecated Use `productVariants` field instead. + */ variants?: Maybe>; /** Weight of the product. */ weight?: Maybe; }; +/** Represents an individual item for sale in the storefront. */ +export type ProductAssignedAttributeArgs = { + slug: Scalars['String']['input']; +}; + + +/** Represents an individual item for sale in the storefront. */ +export type ProductAssignedAttributesArgs = { + limit?: InputMaybe; +}; + + /** Represents an individual item for sale in the storefront. */ export type ProductAttributeArgs = { slug: Scalars['String']['input']; @@ -20177,7 +19843,7 @@ export type ProductAttributeArgs = { /** Represents an individual item for sale in the storefront. */ export type ProductImageByIdArgs = { - id?: InputMaybe; + id: Scalars['ID']['input']; }; @@ -20195,7 +19861,7 @@ export type ProductMediaArgs = { /** Represents an individual item for sale in the storefront. */ export type ProductMediaByIdArgs = { - id?: InputMaybe; + id: Scalars['ID']['input']; }; @@ -20229,6 +19895,18 @@ export type ProductPrivateMetafieldsArgs = { }; +/** Represents an individual item for sale in the storefront. */ +export type ProductProductVariantsArgs = { + after?: InputMaybe; + before?: InputMaybe; + filter?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + sortBy?: InputMaybe; + where?: InputMaybe; +}; + + /** Represents an individual item for sale in the storefront. */ export type ProductThumbnailArgs = { format?: InputMaybe; @@ -20256,7 +19934,7 @@ export type ProductVariantArgs = { export type ProductAttributeAssign = { __typename?: 'ProductAttributeAssign'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; /** The updated product type. */ productType?: Maybe; @@ -20267,25 +19945,19 @@ export type ProductAttributeAssignInput = { id: Scalars['ID']['input']; /** The attribute type to be assigned as. */ type: ProductAttributeType; - /** - * Whether attribute is allowed in variant selection. Allowed types are: ['dropdown', 'boolean', 'swatch', 'numeric']. - * - * Added in Saleor 3.1. - */ + /** Whether attribute is allowed in variant selection. Allowed types are: ['dropdown', 'boolean', 'swatch', 'numeric']. */ variantSelection?: InputMaybe; }; /** * Update attributes assigned to product variant for given product type. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. */ export type ProductAttributeAssignmentUpdate = { __typename?: 'ProductAttributeAssignmentUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; /** The updated product type. */ productType?: Maybe; @@ -20294,11 +19966,7 @@ export type ProductAttributeAssignmentUpdate = { export type ProductAttributeAssignmentUpdateInput = { /** The ID of the attribute to assign. */ id: Scalars['ID']['input']; - /** - * Whether attribute is allowed in variant selection. Allowed types are: ['dropdown', 'boolean', 'swatch', 'numeric']. - * - * Added in Saleor 3.1. - */ + /** Whether attribute is allowed in variant selection. Allowed types are: ['dropdown', 'boolean', 'swatch', 'numeric']. */ variantSelection: Scalars['Boolean']['input']; }; @@ -20314,7 +19982,7 @@ export type ProductAttributeType = export type ProductAttributeUnassign = { __typename?: 'ProductAttributeUnassign'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; /** The updated product type. */ productType?: Maybe; @@ -20323,10 +19991,6 @@ export type ProductAttributeUnassign = { /** * Creates products. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_PRODUCTS. */ export type ProductBulkCreate = { @@ -20356,7 +20020,6 @@ export type ProductBulkCreateError = { warehouses?: Maybe>; }; -/** An enumeration. */ export type ProductBulkCreateErrorCode = | 'ATTRIBUTE_ALREADY_ASSIGNED' | 'ATTRIBUTE_CANNOT_BE_ASSIGNED' @@ -20383,8 +20046,7 @@ export type ProductBulkCreateInput = { channelListings?: InputMaybe>; /** * Determine if taxes are being charged for the product. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to configure whether tax collection is enabled. + * @deprecated Use `Channel.taxConfiguration` to configure whether tax collection is enabled. */ chargeTaxes?: InputMaybe; /** List of IDs of collections that the product belongs to. */ @@ -20399,11 +20061,19 @@ export type ProductBulkCreateInput = { externalReference?: InputMaybe; /** List of media inputs associated with the product. */ media?: InputMaybe>; - /** Fields required to update the product metadata. */ + /** + * Fields required to update the product metadata. Can be read by any API client authorized to read the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ metadata?: InputMaybe>; /** Product name. */ name?: InputMaybe; - /** Fields required to update the product private metadata. */ + /** + * Fields required to update the product private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ privateMetadata?: InputMaybe>; /** ID of the type that product belongs to. */ productType: Scalars['ID']['input']; @@ -20417,8 +20087,7 @@ export type ProductBulkCreateInput = { taxClass?: InputMaybe; /** * Tax rate for enabled tax gateway. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use tax classes to control the tax calculation for a product. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned. + * @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. */ taxCode?: InputMaybe; /** Input list of product variants to create. */ @@ -20437,7 +20106,7 @@ export type ProductBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -20452,10 +20121,6 @@ export type ProductBulkResult = { /** * Creates/updates translations for products. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. * * Triggers the following webhook events: @@ -20503,13 +20168,9 @@ export type ProductBulkTranslateResult = { /** Represents product channel listing. */ export type ProductChannelListing = Node & { __typename?: 'ProductChannelListing'; - /** @deprecated This field will be removed in Saleor 4.0. Use the `availableForPurchaseAt` field to fetch the available for purchase date. */ + /** @deprecated Use the `availableForPurchaseAt` field to fetch the available for purchase date. */ availableForPurchase?: Maybe; - /** - * The product available for purchase date time. - * - * Added in Saleor 3.3. - */ + /** The product available for purchase date time. */ availableForPurchaseAt?: Maybe; /** The channel in which the product is listed. */ channel: Channel; @@ -20529,13 +20190,9 @@ export type ProductChannelListing = Node & { margin?: Maybe; /** Lists the storefront product's pricing, the current price and discounts, only meant for displaying. */ pricing?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use the `publishedAt` field to fetch the publication date. */ + /** @deprecated Use the `publishedAt` field to fetch the publication date. */ publicationDate?: Maybe; - /** - * The product publication date time. - * - * Added in Saleor 3.3. - */ + /** The product publication date time. */ publishedAt?: Maybe; /** * Purchase cost of product. @@ -20556,16 +20213,11 @@ export type ProductChannelListingPricingArgs = { export type ProductChannelListingAddInput = { /** List of variants to which the channel should be assigned. */ addVariants?: InputMaybe>; - /** - * A start date time from which a product will be available for purchase. When not set and `isAvailable` is set to True, the current day is assumed. - * - * Added in Saleor 3.3. - */ + /** 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?: 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: this field will be removed in Saleor 4.0. Use `availableForPurchaseAt` field instead. + * @deprecated Use `availableForPurchaseAt` field instead. */ availableForPurchaseDate?: InputMaybe; /** ID of a channel. */ @@ -20576,15 +20228,10 @@ export type ProductChannelListingAddInput = { isPublished?: InputMaybe; /** * Publication date. ISO 8601 standard. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead. + * @deprecated Use `publishedAt` field instead. */ publicationDate?: InputMaybe; - /** - * Publication date time. ISO 8601 standard. - * - * Added in Saleor 3.3. - */ + /** Publication date time. ISO 8601 standard. */ publishedAt?: InputMaybe; /** List of variants from which the channel should be unassigned. */ removeVariants?: InputMaybe>; @@ -20635,7 +20282,7 @@ export type ProductChannelListingUpdate = { errors: Array; /** An updated product instance. */ product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productChannelListingErrors: Array; }; @@ -20672,7 +20319,7 @@ export type ProductCreate = { __typename?: 'ProductCreate'; errors: Array; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -20683,8 +20330,7 @@ export type ProductCreateInput = { category?: InputMaybe; /** * Determine if taxes are being charged for the product. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to configure whether tax collection is enabled. + * @deprecated Use `Channel.taxConfiguration` to configure whether tax collection is enabled. */ chargeTaxes?: InputMaybe; /** List of IDs of collections that the product belongs to. */ @@ -20695,24 +20341,20 @@ export type ProductCreateInput = { * Rich text format. For reference see https://editorjs.io/ */ description?: InputMaybe; - /** - * External ID of this product. - * - * Added in Saleor 3.10. - */ + /** External ID of this product. */ externalReference?: InputMaybe; /** - * Fields required to update the product metadata. + * Fields required to update the product metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Product name. */ name?: InputMaybe; /** - * Fields required to update the product private metadata. + * Fields required to update the product private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** ID of the type that product belongs to. */ @@ -20727,19 +20369,14 @@ export type ProductCreateInput = { taxClass?: InputMaybe; /** * Tax rate for enabled tax gateway. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use tax classes to control the tax calculation for a product. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned. + * @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. */ taxCode?: InputMaybe; /** Weight of the Product. */ weight?: InputMaybe; }; -/** - * Event sent when new product is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new product is created. */ export type ProductCreated = Event & { __typename?: 'ProductCreated'; /** The category of the product. */ @@ -20757,11 +20394,7 @@ export type ProductCreated = Event & { }; -/** - * Event sent when new product is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new product is created. */ export type ProductCreatedProductArgs = { channel?: InputMaybe; }; @@ -20775,15 +20408,11 @@ export type ProductDelete = { __typename?: 'ProductDelete'; errors: Array; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; -/** - * Event sent when product is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when product is deleted. */ export type ProductDeleted = Event & { __typename?: 'ProductDeleted'; /** The category of the product. */ @@ -20801,11 +20430,7 @@ export type ProductDeleted = Event & { }; -/** - * Event sent when product is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when product is deleted. */ export type ProductDeletedProductArgs = { channel?: InputMaybe; }; @@ -20824,7 +20449,6 @@ export type ProductError = { values?: Maybe>; }; -/** An enumeration. */ export type ProductErrorCode = | 'ALREADY_EXISTS' | 'ATTRIBUTE_ALREADY_ASSIGNED' @@ -20834,6 +20458,7 @@ export type ProductErrorCode = | 'DUPLICATED_INPUT_ITEM' | 'GRAPHQL_ERROR' | 'INVALID' + | 'INVALID_FILE_TYPE' | 'INVALID_PRICE' | 'MEDIA_ALREADY_ASSIGNED' | 'NOT_FOUND' @@ -20845,13 +20470,10 @@ export type ProductErrorCode = | 'REQUIRED' | 'UNIQUE' | 'UNSUPPORTED_MEDIA_PROVIDER' + | 'UNSUPPORTED_MIME_TYPE' | 'VARIANT_NO_DIGITAL_CONTENT'; -/** - * Event sent when product export is completed. - * - * Added in Saleor 3.16. - */ +/** Event sent when product export is completed. */ export type ProductExportCompleted = Event & { __typename?: 'ProductExportCompleted'; /** The export file for products. */ @@ -20882,17 +20504,12 @@ export type ProductFieldEnum = export type ProductFilterInput = { attributes?: InputMaybe>; - /** - * Filter by the date of availability for purchase. - * - * Added in Saleor 3.8. - */ + /** Filter by the date of availability for purchase. */ availableFrom?: InputMaybe; categories?: InputMaybe>; /** * Specifies the channel by which the data should be filtered. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. + * @deprecated Use root-level channel argument instead. */ channel?: InputMaybe; collections?: InputMaybe>; @@ -20901,29 +20518,17 @@ export type ProductFilterInput = { hasCategory?: InputMaybe; hasPreorderedVariants?: InputMaybe; ids?: InputMaybe>; - /** - * Filter by availability for purchase. - * - * Added in Saleor 3.8. - */ + /** Filter by availability for purchase. */ isAvailable?: InputMaybe; isPublished?: InputMaybe; - /** - * Filter by visibility in product listings. - * - * Added in Saleor 3.8. - */ + /** Filter by visibility in product listings. */ isVisibleInListing?: InputMaybe; metadata?: InputMaybe>; /** Filter by the lowest variant price after discounts. */ minimalPrice?: InputMaybe; price?: InputMaybe; productTypes?: InputMaybe>; - /** - * Filter by the publication date. - * - * Added in Saleor 3.8. - */ + /** Filter by the publication date. */ publishedFrom?: InputMaybe; search?: InputMaybe; slugs?: InputMaybe>; @@ -20961,8 +20566,7 @@ export type ProductInput = { category?: InputMaybe; /** * Determine if taxes are being charged for the product. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to configure whether tax collection is enabled. + * @deprecated Use `Channel.taxConfiguration` to configure whether tax collection is enabled. */ chargeTaxes?: InputMaybe; /** List of IDs of collections that the product belongs to. */ @@ -20973,24 +20577,20 @@ export type ProductInput = { * Rich text format. For reference see https://editorjs.io/ */ description?: InputMaybe; - /** - * External ID of this product. - * - * Added in Saleor 3.10. - */ + /** External ID of this product. */ externalReference?: InputMaybe; /** - * Fields required to update the product metadata. + * Fields required to update the product metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Product name. */ name?: InputMaybe; /** - * Fields required to update the product private metadata. + * Fields required to update the product private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** Defines the product rating value. */ @@ -21003,8 +20603,7 @@ export type ProductInput = { taxClass?: InputMaybe; /** * Tax rate for enabled tax gateway. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use tax classes to control the tax calculation for a product. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned. + * @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. */ taxCode?: InputMaybe; /** Weight of the Product. */ @@ -21018,53 +20617,29 @@ export type ProductMedia = Node & ObjectWithMetadata & { alt: Scalars['String']['output']; /** The unique ID of the product media. */ id: Scalars['ID']['output']; - /** - * List of public metadata items. Can be accessed without permissions. - * - * Added in Saleor 3.12. - */ + /** List of public metadata items. Can be accessed without permissions. */ metadata: Array; /** * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.12. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.12. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** The oEmbed data of the media. */ oembedData: Scalars['JSONString']['output']; - /** - * List of private metadata items. Requires staff permissions to access. - * - * Added in Saleor 3.12. - */ + /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; /** * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.12. */ 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. - * - * Added in Saleor 3.12. - */ + /** 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; - /** - * Product id the media refers to. - * - * Added in Saleor 3.12. - */ + /** Product id the media refers to. */ productId?: Maybe; /** The sort order of the media. */ sortOrder?: Maybe; @@ -21115,7 +20690,7 @@ export type ProductMediaBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -21129,7 +20704,7 @@ export type ProductMediaCreate = { errors: Array; media?: Maybe; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -21144,11 +20719,7 @@ export type ProductMediaCreateInput = { product: Scalars['ID']['input']; }; -/** - * Event sent when new product media is created. - * - * Added in Saleor 3.12. - */ +/** Event sent when new product media is created. */ export type ProductMediaCreated = Event & { __typename?: 'ProductMediaCreated'; /** Time of the event. */ @@ -21173,15 +20744,11 @@ export type ProductMediaDelete = { errors: Array; media?: Maybe; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; -/** - * Event sent when product media is deleted. - * - * Added in Saleor 3.12. - */ +/** Event sent when product media is deleted. */ export type ProductMediaDeleted = Event & { __typename?: 'ProductMediaDeleted'; /** Time of the event. */ @@ -21206,11 +20773,10 @@ export type ProductMediaReorder = { errors: Array; media?: Maybe>; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; -/** An enumeration. */ export type ProductMediaType = | 'IMAGE' | 'VIDEO'; @@ -21225,7 +20791,7 @@ export type ProductMediaUpdate = { errors: Array; media?: Maybe; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -21234,11 +20800,7 @@ export type ProductMediaUpdateInput = { alt?: InputMaybe; }; -/** - * Event sent when product media is updated. - * - * Added in Saleor 3.12. - */ +/** Event sent when product media is updated. */ export type ProductMediaUpdated = Event & { __typename?: 'ProductMediaUpdated'; /** Time of the event. */ @@ -21253,11 +20815,7 @@ export type ProductMediaUpdated = Event & { version?: Maybe; }; -/** - * Event sent when product metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when product metadata is updated. */ export type ProductMetadataUpdated = Event & { __typename?: 'ProductMetadataUpdated'; /** The category of the product. */ @@ -21275,11 +20833,7 @@ export type ProductMetadataUpdated = Event & { }; -/** - * Event sent when product metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when product metadata is updated. */ export type ProductMetadataUpdatedProductArgs = { channel?: InputMaybe; }; @@ -21292,8 +20846,7 @@ export type ProductOrder = { attributeId?: InputMaybe; /** * Specifies the channel in which to sort the data. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. + * @deprecated Use root-level channel argument instead. */ channel?: InputMaybe; /** Specifies the direction in which to sort products. */ @@ -21309,11 +20862,7 @@ export type ProductOrderField = * This option requires a channel filter to work as the values can vary between channels. */ | 'COLLECTION' - /** - * Sort products by creation date. - * - * Added in Saleor 3.8. - */ + /** Sort products by creation date. */ | 'CREATED_AT' /** Sort products by update date. */ | 'DATE' @@ -21367,14 +20916,16 @@ export type ProductPricingInfo = { discount?: Maybe; /** * The discount amount in the local currency. - * @deprecated This field will be removed in Saleor 4.0. Always returns `null`. + * @deprecated Always returns `null`. */ discountLocalCurrency?: Maybe; /** - * Determines whether displayed prices should include taxes. + * 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.9. + * Added in Saleor 3.21. */ + discountPrior?: Maybe; + /** Determines whether displayed prices should include taxes. */ displayGrossPrices: Scalars['Boolean']['output']; /** Whether it is in sale or not. */ onSale?: Maybe; @@ -21382,9 +20933,15 @@ export type ProductPricingInfo = { priceRange?: Maybe; /** * The discounted price range of the product variants in the local currency. - * @deprecated This field will be removed in Saleor 4.0. Always returns `null`. + * @deprecated Always returns `null`. */ priceRangeLocalCurrency?: Maybe; + /** + * The prior price range of the product variants. + * + * Added in Saleor 3.21. + */ + priceRangePrior?: Maybe; /** The undiscounted price range of the product variants. */ priceRangeUndiscounted?: Maybe; }; @@ -21399,7 +20956,7 @@ export type ProductReorderAttributeValues = { errors: Array; /** Product from which attribute values are reordered. */ product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -21423,7 +20980,7 @@ export type ProductTranslatableContent = Node & { * Description of the product. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `description` field instead. + * @deprecated Use the `description` field instead. */ descriptionJson?: Maybe; /** The ID of the product translatable content. */ @@ -21432,19 +20989,21 @@ export type ProductTranslatableContent = Node & { name: Scalars['String']['output']; /** * Represents an individual item for sale in the storefront. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ product?: Maybe; - /** - * The ID of the product to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the product to translate. */ productId: Scalars['ID']['output']; /** SEO description to translate. */ seoDescription?: Maybe; /** SEO title to translate. */ seoTitle?: Maybe; + /** + * Slug to translate. + * + * Added in Saleor 3.21. + */ + slug?: Maybe; /** Returns translated product fields for the given language code. */ translation?: Maybe; }; @@ -21464,11 +21023,10 @@ export type ProductTranslate = { __typename?: 'ProductTranslate'; errors: Array; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; -/** An enumeration. */ export type ProductTranslateErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' @@ -21488,7 +21046,7 @@ export type ProductTranslation = Node & { * Translated description of the product. * * Rich text format. For reference see https://editorjs.io/ - * @deprecated This field will be removed in Saleor 4.0. Use the `description` field instead. + * @deprecated Use the `description` field instead. */ descriptionJson?: Maybe; /** The ID of the product translation. */ @@ -21502,21 +21060,19 @@ export type ProductTranslation = Node & { /** Translated SEO title. */ seoTitle?: Maybe; /** - * Represents the product fields to translate. + * Translated product slug. * - * Added in Saleor 3.14. + * Added in Saleor 3.21. */ + slug?: Maybe; + /** Represents the product fields to translate. */ translatableContent?: Maybe; }; /** Represents a type of product. It defines what attributes are available to products of this type. */ export type ProductType = Node & ObjectWithMetadata & { __typename?: 'ProductType'; - /** - * Variant attributes of that product type with attached variant selection. - * - * Added in Saleor 3.1. - */ + /** Variant attributes of that product type with attached variant selection. */ assignedVariantAttributes?: Maybe>; /** * List of attributes which can be assigned to this product type. @@ -21540,15 +21096,9 @@ export type ProductType = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Name of the product type. */ name: Scalars['String']['output']; @@ -21558,21 +21108,15 @@ export type ProductType = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** Product attributes of that product type. */ productAttributes?: Maybe>; /** * List of products of this type. - * @deprecated This field will be removed in Saleor 4.0. Use the top-level `products` query with the `productTypes` filter. + * @deprecated Use the top-level `products` query with the `productTypes` filter. */ products?: Maybe; /** Slug of the product type. */ @@ -21585,12 +21129,12 @@ export type ProductType = Node & ObjectWithMetadata & { taxClass?: Maybe; /** * A type of tax. Assigned by enabled tax gateway - * @deprecated This field will be removed in Saleor 4.0. Use `taxClass` field instead. + * @deprecated Use `taxClass` field instead. */ taxType?: Maybe; /** * Variant attributes of that product type. - * @deprecated This field will be removed in Saleor 4.0. Use `assignedVariantAttributes` instead. + * @deprecated Use `assignedVariantAttributes` instead. */ variantAttributes?: Maybe>; /** Weight of the product type. */ @@ -21611,6 +21155,7 @@ export type ProductTypeAvailableAttributesArgs = { filter?: InputMaybe; first?: InputMaybe; last?: InputMaybe; + search?: InputMaybe; where?: InputMaybe; }; @@ -21664,7 +21209,7 @@ export type ProductTypeBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -21697,7 +21242,7 @@ export type ProductTypeCountableEdge = { export type ProductTypeCreate = { __typename?: 'ProductTypeCreate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; productType?: Maybe; }; @@ -21710,7 +21255,7 @@ export type ProductTypeCreate = { export type ProductTypeDelete = { __typename?: 'ProductTypeDelete'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; productType?: Maybe; }; @@ -21748,8 +21293,7 @@ export type ProductTypeInput = { taxClass?: InputMaybe; /** * Tax rate for enabled tax gateway. - * - * DEPRECATED: this field will be removed in Saleor 4.0.. Use tax classes to control the tax calculation for a product type. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned. + * @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. */ taxCode?: InputMaybe; /** List of attributes used to distinguish between different variants of a product. */ @@ -21758,7 +21302,6 @@ export type ProductTypeInput = { weight?: InputMaybe; }; -/** An enumeration. */ export type ProductTypeKindEnum = | 'GIFT_CARD' | 'NORMAL'; @@ -21771,7 +21314,7 @@ export type ProductTypeKindEnum = export type ProductTypeReorderAttributes = { __typename?: 'ProductTypeReorderAttributes'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; /** Product type from which attributes are reordered. */ productType?: Maybe; @@ -21800,7 +21343,7 @@ export type ProductTypeSortingInput = { export type ProductTypeUpdate = { __typename?: 'ProductTypeUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; productType?: Maybe; }; @@ -21814,15 +21357,11 @@ export type ProductUpdate = { __typename?: 'ProductUpdate'; errors: Array; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; -/** - * Event sent when product is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when product is updated. */ export type ProductUpdated = Event & { __typename?: 'ProductUpdated'; /** The category of the product. */ @@ -21840,19 +21379,30 @@ export type ProductUpdated = Event & { }; -/** - * Event sent when product is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when product is updated. */ export type ProductUpdatedProductArgs = { channel?: InputMaybe; }; /** Represents a version of a product such as different size or color. */ -export type ProductVariant = Node & ObjectWithMetadata & { +export type ProductVariant = Node & ObjectWithAttributes & ObjectWithMetadata & { __typename?: 'ProductVariant'; - /** List of attributes assigned to this variant. */ + /** + * Get a single attribute attached to product by attribute slug. + * + * Added in Saleor 3.22. + */ + assignedAttribute?: Maybe; + /** + * List of attributes assigned to this variant. + * + * Added in Saleor 3.22. + */ + assignedAttributes: Array; + /** + * List of attributes assigned to this variant. + * @deprecated Use the `assignedAttributes` field instead. + */ attributes: Array; /** Channel given to retrieve this product variant. Also used by federation gateway to resolve this object in a federated query. */ channel?: Maybe; @@ -21870,17 +21420,13 @@ export type ProductVariant = Node & ObjectWithMetadata & { * Requires one of the following permissions: MANAGE_PRODUCTS. */ digitalContent?: Maybe; - /** - * External ID of this product. - * - * Added in Saleor 3.10. - */ + /** External ID of this product. */ externalReference?: Maybe; /** The ID of the product variant. */ id: Scalars['ID']['output']; /** * List of images for the product variant. - * @deprecated This field will be removed in Saleor 4.0. Use the `media` field instead. + * @deprecated Use the `media` field instead. */ images?: Maybe>; /** Gross margin percentage value. */ @@ -21893,23 +21439,13 @@ export type ProductVariant = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** The name of the product variant. */ name: Scalars['String']['output']; - /** - * Preorder data for product variant. - * - * Added in Saleor 3.1. - */ + /** Preorder data for product variant. */ preorder?: Maybe; /** Lists the storefront variant's pricing, the current price and discounts, only meant for displaying. */ pricing?: Maybe; @@ -21919,15 +21455,9 @@ export type ProductVariant = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** The product to which the variant belongs. */ product: Product; @@ -21966,6 +21496,18 @@ export type ProductVariant = Node & ObjectWithMetadata & { }; +/** Represents a version of a product such as different size or color. */ +export type ProductVariantAssignedAttributeArgs = { + slug: Scalars['String']['input']; +}; + + +/** Represents a version of a product such as different size or color. */ +export type ProductVariantAssignedAttributesArgs = { + limit?: InputMaybe; +}; + + /** Represents a version of a product such as different size or color. */ export type ProductVariantAttributesArgs = { variantSelection?: InputMaybe; @@ -22027,11 +21569,7 @@ export type ProductVariantTranslationArgs = { languageCode: LanguageCodeEnum; }; -/** - * Event sent when product variant is back in stock. - * - * Added in Saleor 3.2. - */ +/** Event sent when product variant is back in stock. */ export type ProductVariantBackInStock = Event & { __typename?: 'ProductVariantBackInStock'; /** Time of the event. */ @@ -22049,11 +21587,7 @@ export type ProductVariantBackInStock = Event & { }; -/** - * Event sent when product variant is back in stock. - * - * Added in Saleor 3.2. - */ +/** Event sent when product variant is back in stock. */ export type ProductVariantBackInStockProductVariantArgs = { channel?: InputMaybe; }; @@ -22065,18 +21599,14 @@ export type ProductVariantBackInStockProductVariantArgs = { */ export type ProductVariantBulkCreate = { __typename?: 'ProductVariantBulkCreate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ bulkProductErrors: Array; /** Returns how many objects were created. */ count: Scalars['Int']['output']; errors: Array; - /** List of the created variants.This field will be removed in Saleor 4.0. */ + /** List of the created variants. */ productVariants: Array; - /** - * List of the created variants. - * - * Added in Saleor 3.11. - */ + /** List of the created variants. */ results: Array; }; @@ -22085,37 +21615,25 @@ export type ProductVariantBulkCreateInput = { attributes: Array; /** List of prices assigned to channels. */ channelListings?: InputMaybe>; - /** - * External ID of this product variant. - * - * Added in Saleor 3.10. - */ + /** External ID of this product variant. */ externalReference?: InputMaybe; /** - * Fields required to update the product variant metadata. + * Fields required to update the product variant metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Variant name. */ name?: InputMaybe; - /** - * Determines if variant is in preorder. - * - * Added in Saleor 3.1. - */ + /** Determines if variant is in preorder. */ preorder?: InputMaybe; /** - * Fields required to update the product variant private metadata. + * Fields required to update the product variant private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; - /** - * Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. - * - * Added in Saleor 3.1. - */ + /** Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. */ quantityLimitPerCustomer?: InputMaybe; /** Stock keeping unit. */ sku?: InputMaybe; @@ -22137,7 +21655,7 @@ export type ProductVariantBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -22147,11 +21665,7 @@ export type ProductVariantBulkError = { attributes?: Maybe>; /** List of channel listings IDs which causes the error. */ channelListings?: Maybe>; - /** - * List of channel IDs which causes the error. - * - * Added in Saleor 3.12. - */ + /** List of channel IDs which causes the error. */ channels?: Maybe>; /** The error code. */ code: ProductVariantBulkErrorCode; @@ -22159,17 +21673,9 @@ export type ProductVariantBulkError = { field?: Maybe; /** The error message. */ message?: Maybe; - /** - * Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. - * - * Added in Saleor 3.14. - */ + /** Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ path?: Maybe; - /** - * List of stocks IDs which causes the error. - * - * Added in Saleor 3.12. - */ + /** List of stocks IDs which causes the error. */ stocks?: Maybe>; /** List of attribute values IDs which causes the error. */ values?: Maybe>; @@ -22177,7 +21683,6 @@ export type ProductVariantBulkError = { warehouses?: Maybe>; }; -/** An enumeration. */ export type ProductVariantBulkErrorCode = | 'ATTRIBUTE_ALREADY_ASSIGNED' | 'ATTRIBUTE_CANNOT_BE_ASSIGNED' @@ -22202,11 +21707,7 @@ export type ProductVariantBulkResult = { }; /** - * Creates/updates translations for products variants. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Creates/updates translations for product variants. * * Requires one of the following permissions: MANAGE_TRANSLATIONS. * @@ -22253,11 +21754,7 @@ export type ProductVariantBulkTranslateResult = { }; /** - * Update multiple product variants. - * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Updates multiple product variants. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ @@ -22270,65 +21767,37 @@ export type ProductVariantBulkUpdate = { results: Array; }; -/** - * Input fields to update product variants. - * - * Added in Saleor 3.11. - */ +/** Input fields to update product variants. */ export type ProductVariantBulkUpdateInput = { /** List of attributes specific to this variant. */ attributes?: InputMaybe>; - /** - * Channel listings input. - * - * Added in Saleor 3.12. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Channel listings input. */ channelListings?: InputMaybe; - /** - * External ID of this product variant. - * - * Added in Saleor 3.10. - */ + /** External ID of this product variant. */ externalReference?: InputMaybe; /** ID of the product variant to update. */ id: Scalars['ID']['input']; /** - * Fields required to update the product variant metadata. + * Fields required to update the product variant metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Variant name. */ name?: InputMaybe; - /** - * Determines if variant is in preorder. - * - * Added in Saleor 3.1. - */ + /** Determines if variant is in preorder. */ preorder?: InputMaybe; /** - * Fields required to update the product variant private metadata. + * Fields required to update the product variant private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; - /** - * Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. - * - * Added in Saleor 3.1. - */ + /** Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. */ quantityLimitPerCustomer?: InputMaybe; /** Stock keeping unit. */ sku?: InputMaybe; - /** - * Stocks input. - * - * Added in Saleor 3.12. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Stocks input. */ stocks?: InputMaybe; /** 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?: InputMaybe; @@ -22351,14 +21820,16 @@ export type ProductVariantChannelListing = Node & { * Requires one of the following permissions: MANAGE_PRODUCTS. */ margin?: Maybe; - /** - * Preorder variant data. - * - * Added in Saleor 3.1. - */ + /** Preorder variant data. */ preorderThreshold?: Maybe; /** The price of the variant. */ price?: Maybe; + /** + * Prior price of the variant used for discount calculations. + * + * Added in Saleor 3.21. + */ + priorPrice?: Maybe; }; export type ProductVariantChannelListingAddInput = { @@ -22366,14 +21837,16 @@ export type ProductVariantChannelListingAddInput = { channelId: Scalars['ID']['input']; /** Cost price of the variant in channel. */ costPrice?: InputMaybe; - /** - * The threshold for preorder variant in channel. - * - * Added in Saleor 3.1. - */ + /** The threshold for preorder variant in channel. */ preorderThreshold?: InputMaybe; /** Price of the particular variant in channel. */ price: Scalars['PositiveDecimal']['input']; + /** + * Previous price of the variant in channel. Useful for providing promotion information required by customer protection laws such as EU Omnibus directive. + * + * Added in Saleor 3.21. + */ + priorPrice?: InputMaybe; }; /** @@ -22384,7 +21857,7 @@ export type ProductVariantChannelListingAddInput = { export type ProductVariantChannelListingUpdate = { __typename?: 'ProductVariantChannelListingUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productChannelListingErrors: Array; /** An updated product variant instance. */ variant?: Maybe; @@ -22424,7 +21897,7 @@ export type ProductVariantCountableEdge = { export type ProductVariantCreate = { __typename?: 'ProductVariantCreate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; productVariant?: Maybe; }; @@ -22432,39 +21905,27 @@ export type ProductVariantCreate = { export type ProductVariantCreateInput = { /** List of attributes specific to this variant. */ attributes: Array; - /** - * External ID of this product variant. - * - * Added in Saleor 3.10. - */ + /** External ID of this product variant. */ externalReference?: InputMaybe; /** - * Fields required to update the product variant metadata. + * Fields required to update the product variant metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Variant name. */ name?: InputMaybe; - /** - * Determines if variant is in preorder. - * - * Added in Saleor 3.1. - */ + /** Determines if variant is in preorder. */ preorder?: InputMaybe; /** - * Fields required to update the product variant private metadata. + * Fields required to update the product variant private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** Product ID of which type is the variant. */ product: Scalars['ID']['input']; - /** - * Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. - * - * Added in Saleor 3.1. - */ + /** Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. */ quantityLimitPerCustomer?: InputMaybe; /** Stock keeping unit. */ sku?: InputMaybe; @@ -22474,13 +21935,9 @@ export type ProductVariantCreateInput = { trackInventory?: InputMaybe; /** Weight of the Product Variant. */ weight?: InputMaybe; -}; - -/** - * Event sent when new product variant is created. - * - * Added in Saleor 3.2. - */ +}; + +/** Event sent when new product variant is created. */ export type ProductVariantCreated = Event & { __typename?: 'ProductVariantCreated'; /** Time of the event. */ @@ -22496,11 +21953,7 @@ export type ProductVariantCreated = Event & { }; -/** - * Event sent when new product variant is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new product variant is created. */ export type ProductVariantCreatedProductVariantArgs = { channel?: InputMaybe; }; @@ -22513,16 +21966,12 @@ export type ProductVariantCreatedProductVariantArgs = { export type ProductVariantDelete = { __typename?: 'ProductVariantDelete'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; productVariant?: Maybe; }; -/** - * Event sent when product variant is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when product variant is deleted. */ export type ProductVariantDeleted = Event & { __typename?: 'ProductVariantDeleted'; /** Time of the event. */ @@ -22538,11 +21987,7 @@ export type ProductVariantDeleted = Event & { }; -/** - * Event sent when product variant is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when product variant is deleted. */ export type ProductVariantDeletedProductVariantArgs = { channel?: InputMaybe; }; @@ -22558,37 +22003,25 @@ export type ProductVariantFilterInput = { export type ProductVariantInput = { /** List of attributes specific to this variant. */ attributes?: InputMaybe>; - /** - * External ID of this product variant. - * - * Added in Saleor 3.10. - */ + /** External ID of this product variant. */ externalReference?: InputMaybe; /** - * Fields required to update the product variant metadata. + * Fields required to update the product variant metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Variant name. */ name?: InputMaybe; - /** - * Determines if variant is in preorder. - * - * Added in Saleor 3.1. - */ + /** Determines if variant is in preorder. */ preorder?: InputMaybe; /** - * Fields required to update the product variant private metadata. + * Fields required to update the product variant private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.8. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; - /** - * Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. - * - * Added in Saleor 3.1. - */ + /** Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. */ quantityLimitPerCustomer?: InputMaybe; /** Stock keeping unit. */ sku?: InputMaybe; @@ -22598,11 +22031,7 @@ export type ProductVariantInput = { weight?: InputMaybe; }; -/** - * Event sent when product variant metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when product variant metadata is updated. */ export type ProductVariantMetadataUpdated = Event & { __typename?: 'ProductVariantMetadataUpdated'; /** Time of the event. */ @@ -22618,20 +22047,12 @@ export type ProductVariantMetadataUpdated = Event & { }; -/** - * Event sent when product variant metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when product variant metadata is updated. */ export type ProductVariantMetadataUpdatedProductVariantArgs = { channel?: InputMaybe; }; -/** - * Event sent when product variant is out of stock. - * - * Added in Saleor 3.2. - */ +/** Event sent when product variant is out of stock. */ export type ProductVariantOutOfStock = Event & { __typename?: 'ProductVariantOutOfStock'; /** Time of the event. */ @@ -22649,11 +22070,7 @@ export type ProductVariantOutOfStock = Event & { }; -/** - * Event sent when product variant is out of stock. - * - * Added in Saleor 3.2. - */ +/** Event sent when product variant is out of stock. */ export type ProductVariantOutOfStockProductVariantArgs = { channel?: InputMaybe; }; @@ -22661,8 +22078,6 @@ export type ProductVariantOutOfStockProductVariantArgs = { /** * Deactivates product variant preorder. It changes all preorder allocation into regular allocation. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_PRODUCTS. */ export type ProductVariantPreorderDeactivate = { @@ -22681,7 +22096,7 @@ export type ProductVariantReorder = { __typename?: 'ProductVariantReorder'; errors: Array; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; @@ -22693,7 +22108,7 @@ export type ProductVariantReorder = { export type ProductVariantReorderAttributeValues = { __typename?: 'ProductVariantReorderAttributeValues'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; /** Product variant from which attribute values are reordered. */ productVariant?: Maybe; @@ -22708,12 +22123,12 @@ export type ProductVariantSetDefault = { __typename?: 'ProductVariantSetDefault'; errors: Array; product?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; }; export type ProductVariantSortField = - /** Sort products variants by last modified at. */ + /** Sort product variants by last modification date. */ | 'LAST_MODIFIED_AT'; export type ProductVariantSortingInput = { @@ -22723,13 +22138,7 @@ export type ProductVariantSortingInput = { field: ProductVariantSortField; }; -/** - * Event sent when product variant stock is updated. - * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when product variant stock is updated. */ export type ProductVariantStockUpdated = Event & { __typename?: 'ProductVariantStockUpdated'; /** Time of the event. */ @@ -22747,13 +22156,7 @@ export type ProductVariantStockUpdated = Event & { }; -/** - * Event sent when product variant stock is updated. - * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when product variant stock is updated. */ export type ProductVariantStockUpdatedProductVariantArgs = { channel?: InputMaybe; }; @@ -22765,7 +22168,7 @@ export type ProductVariantStockUpdatedProductVariantArgs = { */ export type ProductVariantStocksCreate = { __typename?: 'ProductVariantStocksCreate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ bulkStockErrors: Array; errors: Array; /** Updated product variant. */ @@ -22773,7 +22176,7 @@ export type ProductVariantStocksCreate = { }; /** - * Delete stocks from product variant. + * Deletes stocks from product variant. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ @@ -22782,18 +22185,18 @@ export type ProductVariantStocksDelete = { errors: Array; /** Updated product variant. */ productVariant?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ stockErrors: Array; }; /** - * Update stocks for product variant. + * Updates stocks for product variant. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ export type ProductVariantStocksUpdate = { __typename?: 'ProductVariantStocksUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ bulkStockErrors: Array; errors: Array; /** Updated product variant. */ @@ -22820,14 +22223,10 @@ export type ProductVariantTranslatableContent = Node & { name: Scalars['String']['output']; /** * Represents a version of a product such as different size or color. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ productVariant?: Maybe; - /** - * The ID of the product variant to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the product variant to translate. */ productVariantId: Scalars['ID']['output']; /** Returns translated product variant fields for the given language code. */ translation?: Maybe; @@ -22848,11 +22247,10 @@ export type ProductVariantTranslate = { __typename?: 'ProductVariantTranslate'; errors: Array; productVariant?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; -/** An enumeration. */ export type ProductVariantTranslateErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' @@ -22868,11 +22266,7 @@ export type ProductVariantTranslation = Node & { language: LanguageDisplay; /** Translated product variant name. */ name: Scalars['String']['output']; - /** - * Represents the product variant fields to translate. - * - * Added in Saleor 3.14. - */ + /** Represents the product variant fields to translate. */ translatableContent?: Maybe; }; @@ -22884,16 +22278,12 @@ export type ProductVariantTranslation = Node & { export type ProductVariantUpdate = { __typename?: 'ProductVariantUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; productVariant?: Maybe; }; -/** - * Event sent when product variant is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when product variant is updated. */ export type ProductVariantUpdated = Event & { __typename?: 'ProductVariantUpdated'; /** Time of the event. */ @@ -22909,11 +22299,7 @@ export type ProductVariantUpdated = Event & { }; -/** - * Event sent when product variant is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when product variant is updated. */ export type ProductVariantUpdatedProductVariantArgs = { channel?: InputMaybe; }; @@ -22923,8 +22309,18 @@ export type ProductVariantWhereInput = { AND?: InputMaybe>; /** A list of conditions of which at least one must be met. */ OR?: InputMaybe>; + /** + * Filter by attributes associated with the variant. + * + * Added in Saleor 3.22. + */ + attributes?: InputMaybe>; ids?: InputMaybe>; metadata?: InputMaybe>; + /** Filter by product SKU. */ + sku?: InputMaybe; + /** Filter by when was the most recent update. */ + updatedAt?: InputMaybe; }; export type ProductWhereInput = { @@ -22974,13 +22370,7 @@ export type ProductWhereInput = { updatedAt?: InputMaybe; }; -/** - * Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. */ export type Promotion = Node & ObjectWithMetadata & { __typename?: 'Promotion'; /** Date time of promotion creation. */ @@ -22998,15 +22388,9 @@ export type Promotion = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Name of the promotion. */ name: Scalars['String']['output']; @@ -23016,15 +22400,9 @@ export type Promotion = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** The list of promotion rules. */ rules?: Maybe>; @@ -23045,61 +22423,31 @@ export type Promotion = Node & ObjectWithMetadata & { }; -/** - * Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. */ export type PromotionMetafieldArgs = { key: Scalars['String']['input']; }; -/** - * Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. */ export type PromotionMetafieldsArgs = { keys?: InputMaybe>; }; -/** - * Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. */ export type PromotionPrivateMetafieldArgs = { key: Scalars['String']['input']; }; -/** - * Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. */ export type PromotionPrivateMetafieldsArgs = { keys?: InputMaybe>; }; -/** - * Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. */ export type PromotionTranslationArgs = { languageCode: LanguageCodeEnum; }; @@ -23107,10 +22455,6 @@ export type PromotionTranslationArgs = { /** * Deletes promotions. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -23143,10 +22487,6 @@ export type PromotionCountableEdge = { /** * Creates a new promotion. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -23179,7 +22519,6 @@ export type PromotionCreateError = { rulesLimitExceedBy?: Maybe; }; -/** An enumeration. */ export type PromotionCreateErrorCode = | 'GIFTS_NUMBER_LIMIT' | 'GRAPHQL_ERROR' @@ -23211,13 +22550,7 @@ export type PromotionCreateInput = { type: PromotionTypeEnum; }; -/** - * Event sent when new promotion is created. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when new promotion is created. */ export type PromotionCreated = Event & { __typename?: 'PromotionCreated'; /** Time of the event. */ @@ -23232,13 +22565,7 @@ export type PromotionCreated = Event & { version?: Maybe; }; -/** - * History log of the promotion created event. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** History log of the promotion created event. */ export type PromotionCreatedEvent = Node & PromotionEventInterface & { __typename?: 'PromotionCreatedEvent'; /** @@ -23257,10 +22584,6 @@ export type PromotionCreatedEvent = Node & PromotionEventInterface & { /** * Deletes a promotion. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -23282,18 +22605,11 @@ export type PromotionDeleteError = { message?: Maybe; }; -/** An enumeration. */ export type PromotionDeleteErrorCode = | 'GRAPHQL_ERROR' | 'NOT_FOUND'; -/** - * Event sent when promotion is deleted. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when promotion is deleted. */ export type PromotionDeleted = Event & { __typename?: 'PromotionDeleted'; /** Time of the event. */ @@ -23308,13 +22624,7 @@ export type PromotionDeleted = Event & { version?: Maybe; }; -/** - * The event informs about the end of the promotion. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** The event informs about the end of the promotion. */ export type PromotionEnded = Event & { __typename?: 'PromotionEnded'; /** Time of the event. */ @@ -23329,13 +22639,7 @@ export type PromotionEnded = Event & { version?: Maybe; }; -/** - * History log of the promotion ended event. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** History log of the promotion ended event. */ export type PromotionEndedEvent = Node & PromotionEventInterface & { __typename?: 'PromotionEndedEvent'; /** @@ -23367,7 +22671,6 @@ export type PromotionEventInterface = { type: PromotionEventsEnum; }; -/** An enumeration. */ export type PromotionEventsEnum = | 'PROMOTION_CREATED' | 'PROMOTION_ENDED' @@ -23377,13 +22680,7 @@ export type PromotionEventsEnum = | 'RULE_DELETED' | 'RULE_UPDATED'; -/** - * Represents the promotion rule that specifies the conditions that must be met to apply the promotion discount. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the promotion rule that specifies the conditions that must be met to apply the promotion discount. */ export type PromotionRule = Node & { __typename?: 'PromotionRule'; /** The catalogue predicate that must be met to apply the rule reward. */ @@ -23456,13 +22753,7 @@ export type PromotionRule = Node & { }; -/** - * Represents the promotion rule that specifies the conditions that must be met to apply the promotion discount. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents the promotion rule that specifies the conditions that must be met to apply the promotion discount. */ export type PromotionRuleTranslationArgs = { languageCode: LanguageCodeEnum; }; @@ -23470,10 +22761,6 @@ export type PromotionRuleTranslationArgs = { /** * Creates a new promotion rule. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -23503,7 +22790,6 @@ export type PromotionRuleCreateError = { rulesLimitExceedBy?: Maybe; }; -/** An enumeration. */ export type PromotionRuleCreateErrorCode = | 'GIFTS_NUMBER_LIMIT' | 'GRAPHQL_ERROR' @@ -23557,13 +22843,7 @@ export type PromotionRuleCreateInput = { rewardValueType?: InputMaybe; }; -/** - * Event sent when new promotion rule is created. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when new promotion rule is created. */ export type PromotionRuleCreated = Event & { __typename?: 'PromotionRuleCreated'; /** Time of the event. */ @@ -23578,13 +22858,7 @@ export type PromotionRuleCreated = Event & { version?: Maybe; }; -/** - * History log of the promotion rule created event. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** History log of the promotion rule created event. */ export type PromotionRuleCreatedEvent = Node & PromotionEventInterface & PromotionRuleEventInterface & { __typename?: 'PromotionRuleCreatedEvent'; /** @@ -23605,10 +22879,6 @@ export type PromotionRuleCreatedEvent = Node & PromotionEventInterface & Promoti /** * Deletes a promotion rule. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -23630,18 +22900,11 @@ export type PromotionRuleDeleteError = { message?: Maybe; }; -/** An enumeration. */ export type PromotionRuleDeleteErrorCode = | 'GRAPHQL_ERROR' | 'NOT_FOUND'; -/** - * Event sent when new promotion rule is deleted. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when new promotion rule is deleted. */ export type PromotionRuleDeleted = Event & { __typename?: 'PromotionRuleDeleted'; /** Time of the event. */ @@ -23656,13 +22919,7 @@ export type PromotionRuleDeleted = Event & { version?: Maybe; }; -/** - * History log of the promotion rule created event. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** History log of the promotion rule created event. */ export type PromotionRuleDeletedEvent = Node & PromotionEventInterface & PromotionRuleEventInterface & { __typename?: 'PromotionRuleDeletedEvent'; /** @@ -23680,13 +22937,7 @@ export type PromotionRuleDeletedEvent = Node & PromotionEventInterface & Promoti type: PromotionEventsEnum; }; -/** - * History log of the promotion event related to rule. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** History log of the promotion event related to rule. */ export type PromotionRuleEventInterface = { /** The rule ID associated with the promotion event. */ ruleId?: Maybe; @@ -23731,11 +22982,7 @@ export type PromotionRuleInput = { rewardValueType?: InputMaybe; }; -/** - * Represents promotion rule's original translatable fields and related translations. - * - * Added in Saleor 3.17. - */ +/** Represents promotion rule's original translatable fields and related translations. */ export type PromotionRuleTranslatableContent = Node & { __typename?: 'PromotionRuleTranslatableContent'; /** @@ -23748,22 +22995,14 @@ export type PromotionRuleTranslatableContent = Node & { id: Scalars['ID']['output']; /** Name of the promotion rule. */ name?: Maybe; - /** - * ID of the promotion rule to translate. - * - * Added in Saleor 3.14. - */ + /** ID of the promotion rule to translate. */ promotionRuleId: Scalars['ID']['output']; /** Returns translated promotion rule fields for the given language code. */ translation?: Maybe; }; -/** - * Represents promotion rule's original translatable fields and related translations. - * - * Added in Saleor 3.17. - */ +/** Represents promotion rule's original translatable fields and related translations. */ export type PromotionRuleTranslatableContentTranslationArgs = { languageCode: LanguageCodeEnum; }; @@ -23771,8 +23010,6 @@ export type PromotionRuleTranslatableContentTranslationArgs = { /** * Creates/updates translations for a promotion rule. * - * Added in Saleor 3.17. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. */ export type PromotionRuleTranslate = { @@ -23781,11 +23018,7 @@ export type PromotionRuleTranslate = { promotionRule?: Maybe; }; -/** - * Represents promotion rule translations. - * - * Added in Saleor 3.17. - */ +/** Represents promotion rule translations. */ export type PromotionRuleTranslation = Node & { __typename?: 'PromotionRuleTranslation'; /** @@ -23800,11 +23033,7 @@ export type PromotionRuleTranslation = Node & { language: LanguageDisplay; /** Translated name of the promotion rule. */ name?: Maybe; - /** - * Represents the promotion rule fields to translate. - * - * Added in Saleor 3.14. - */ + /** Represents the promotion rule fields to translate. */ translatableContent?: Maybe; }; @@ -23821,10 +23050,6 @@ export type PromotionRuleTranslationInput = { /** * Updates an existing promotion rule. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -23852,7 +23077,6 @@ export type PromotionRuleUpdateError = { message?: Maybe; }; -/** An enumeration. */ export type PromotionRuleUpdateErrorCode = | 'DUPLICATED_INPUT_ITEM' | 'GIFTS_NUMBER_LIMIT' @@ -23914,13 +23138,7 @@ export type PromotionRuleUpdateInput = { rewardValueType?: InputMaybe; }; -/** - * Event sent when new promotion rule is updated. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when new promotion rule is updated. */ export type PromotionRuleUpdated = Event & { __typename?: 'PromotionRuleUpdated'; /** Time of the event. */ @@ -23935,13 +23153,7 @@ export type PromotionRuleUpdated = Event & { version?: Maybe; }; -/** - * History log of the promotion rule created event. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** History log of the promotion rule created event. */ export type PromotionRuleUpdatedEvent = Node & PromotionEventInterface & PromotionRuleEventInterface & { __typename?: 'PromotionRuleUpdatedEvent'; /** @@ -23960,7 +23172,7 @@ export type PromotionRuleUpdatedEvent = Node & PromotionEventInterface & Promoti }; export type PromotionSortField = - /** Sort promotions by created at. */ + /** Sort promotions by creation date. */ | 'CREATED_AT' /** Sort promotions by end date. */ | 'END_DATE' @@ -23976,13 +23188,7 @@ export type PromotionSortingInput = { field: PromotionSortField; }; -/** - * The event informs about the start of the promotion. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** The event informs about the start of the promotion. */ export type PromotionStarted = Event & { __typename?: 'PromotionStarted'; /** Time of the event. */ @@ -23997,13 +23203,7 @@ export type PromotionStarted = Event & { version?: Maybe; }; -/** - * History log of the promotion started event. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** History log of the promotion started event. */ export type PromotionStartedEvent = Node & PromotionEventInterface & { __typename?: 'PromotionStartedEvent'; /** @@ -24019,11 +23219,7 @@ export type PromotionStartedEvent = Node & PromotionEventInterface & { type: PromotionEventsEnum; }; -/** - * Represents promotion's original translatable fields and related translations. - * - * Added in Saleor 3.17. - */ +/** Represents promotion's original translatable fields and related translations. */ export type PromotionTranslatableContent = Node & { __typename?: 'PromotionTranslatableContent'; /** @@ -24043,11 +23239,7 @@ export type PromotionTranslatableContent = Node & { }; -/** - * Represents promotion's original translatable fields and related translations. - * - * Added in Saleor 3.17. - */ +/** Represents promotion's original translatable fields and related translations. */ export type PromotionTranslatableContentTranslationArgs = { languageCode: LanguageCodeEnum; }; @@ -24055,8 +23247,6 @@ export type PromotionTranslatableContentTranslationArgs = { /** * Creates/updates translations for a promotion. * - * Added in Saleor 3.17. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. */ export type PromotionTranslate = { @@ -24065,11 +23255,7 @@ export type PromotionTranslate = { promotion?: Maybe; }; -/** - * Represents promotion translations. - * - * Added in Saleor 3.17. - */ +/** Represents promotion translations. */ export type PromotionTranslation = Node & { __typename?: 'PromotionTranslation'; /** @@ -24084,11 +23270,7 @@ export type PromotionTranslation = Node & { language: LanguageDisplay; /** Translated name of the promotion. */ name?: Maybe; - /** - * Represents the promotion fields to translate. - * - * Added in Saleor 3.14. - */ + /** Represents the promotion fields to translate. */ translatableContent?: Maybe; }; @@ -24102,7 +23284,6 @@ export type PromotionTranslationInput = { name?: InputMaybe; }; -/** An enumeration. */ export type PromotionTypeEnum = | 'CATALOGUE' | 'ORDER'; @@ -24117,10 +23298,6 @@ export type PromotionTypeEnumFilterInput = { /** * Updates an existing promotion. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -24144,7 +23321,6 @@ export type PromotionUpdateError = { message?: Maybe; }; -/** An enumeration. */ export type PromotionUpdateErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' @@ -24162,13 +23338,7 @@ export type PromotionUpdateInput = { startDate?: InputMaybe; }; -/** - * Event sent when promotion is updated. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when promotion is updated. */ export type PromotionUpdated = Event & { __typename?: 'PromotionUpdated'; /** Time of the event. */ @@ -24183,13 +23353,7 @@ export type PromotionUpdated = Event & { version?: Maybe; }; -/** - * History log of the promotion updated event. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** History log of the promotion updated event. */ export type PromotionUpdatedEvent = Node & PromotionEventInterface & { __typename?: 'PromotionUpdatedEvent'; /** @@ -24229,15 +23393,10 @@ export type PublishableChannelListingInput = { isPublished?: InputMaybe; /** * Publication date. ISO 8601 standard. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead. + * @deprecated Use `publishedAt` field instead. */ publicationDate?: InputMaybe; - /** - * Publication date time. ISO 8601 standard. - * - * Added in Saleor 3.3. - */ + /** Publication date time. ISO 8601 standard. */ publishedAt?: InputMaybe; }; @@ -24262,16 +23421,12 @@ export type Query = { /** * Look up an app extension by ID. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */ appExtension?: Maybe; /** * List of all extensions. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */ appExtensions?: Maybe; @@ -24310,18 +23465,18 @@ export type Query = { */ checkout?: Maybe; /** - * List of checkout lines. + * 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. * * Requires one of the following permissions: MANAGE_CHECKOUTS. */ checkoutLines?: Maybe; /** - * List of checkouts. + * 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. * * Requires one of the following permissions: MANAGE_CHECKOUTS, HANDLE_PAYMENTS. */ checkouts?: Maybe; - /** Look up a collection by ID. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. */ + /** 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. */ collection?: Maybe; /** List of the shop's collections. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. */ collections?: Maybe; @@ -24344,7 +23499,7 @@ export type Query = { */ digitalContents?: Maybe; /** - * List of draft orders. + * List of draft 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_ORDERS. */ @@ -24370,8 +23525,6 @@ export type Query = { /** * List of gift card currencies. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. */ giftCardCurrencies: Array; @@ -24384,8 +23537,6 @@ export type Query = { /** * List of gift card tags. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_GIFT_CARD. */ giftCardTags?: Maybe; @@ -24399,7 +23550,7 @@ export type Query = { * List of activity events to display on homepage (at the moment it only contains order-events). * * Requires one of the following permissions: MANAGE_ORDERS. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ homepageEvents?: Maybe; /** Return the currently authenticated user. */ @@ -24416,18 +23567,18 @@ export type Query = { order?: Maybe; /** * Look up an order by token. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ orderByToken?: Maybe; /** * Order related settings from site settings. Returns `orderSettings` for the first `channel` in alphabetical order. * * Requires one of the following permissions: MANAGE_ORDERS. - * @deprecated This field will be removed in Saleor 4.0. Use the `channel` query to fetch the `orderSettings` field instead. + * @deprecated Use the `channel` query to fetch the `orderSettings` field instead. */ orderSettings?: Maybe; /** - * List of orders. + * List of 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_ORDERS. */ @@ -24436,7 +23587,7 @@ export type Query = { * Return the total sales amount from a specific period. * * Requires one of the following permissions: MANAGE_ORDERS. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ ordersTotal?: Maybe; /** Look up a page by ID or slug. */ @@ -24498,42 +23649,36 @@ export type Query = { /** * Look up a promotion by ID. * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. */ promotion?: Maybe; /** - * List of the promotions. - * - * Added in Saleor 3.17. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * List of the promotions. * * Requires one of the following permissions: MANAGE_DISCOUNTS. */ promotions?: Maybe; + /** Refunds related settings. Returns `RefundSettings` configuration, global for the entire shop. */ + refundSettings: RefundSettings; /** * List of top selling products. * * Requires one of the following permissions: MANAGE_PRODUCTS. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ reportProductSales?: Maybe; /** * Look up a sale by ID. * * Requires one of the following permissions: MANAGE_DISCOUNTS. - * @deprecated This field will be removed in Saleor 4.0. Use the `promotion` query instead. + * @deprecated Use the `promotion` query instead. */ sale?: Maybe; /** * List of the shop's sales. * * Requires one of the following permissions: MANAGE_DISCOUNTS. - * @deprecated This field will be removed in Saleor 4.0. Use the `promotions` query instead. + * @deprecated Use the `promotions` query instead. */ sales?: Maybe; /** @@ -24571,32 +23716,24 @@ export type Query = { /** * Look up a tax class. * - * Added in Saleor 3.9. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */ taxClass?: Maybe; /** * List of tax classes. * - * Added in Saleor 3.9. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */ taxClasses?: Maybe; /** * Look up a tax configuration. * - * Added in Saleor 3.9. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */ taxConfiguration?: Maybe; /** * List of tax configurations. * - * Added in Saleor 3.9. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */ taxConfigurations?: Maybe; @@ -24610,19 +23747,23 @@ export type Query = { taxCountryConfigurations?: Maybe>; /** * List of all tax rates available from tax gateway. - * @deprecated This field will be removed in Saleor 4.0. Use `taxClasses` field instead. + * @deprecated Use `taxClasses` field instead. */ taxTypes?: Maybe>; /** * Look up a transaction by ID. * - * Added in Saleor 3.6. + * 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. * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Added in Saleor 3.22. * - * Requires one of the following permissions: HANDLE_PAYMENTS. + * Requires one of the following permissions: HANDLE_PAYMENTS, MANAGE_ORDERS. */ - transaction?: Maybe; + transactions?: Maybe; /** * Lookup a translatable item by ID. * @@ -24671,7 +23812,7 @@ export type Query = { * List of all available webhook events. * * Requires one of the following permissions: MANAGE_APPS. - * @deprecated This field will be removed in Saleor 4.0. Use `WebhookEventTypeAsyncEnum` and `WebhookEventTypeSyncEnum` to get available event types. + * @deprecated Use `WebhookEventTypeAsyncEnum` and `WebhookEventTypeSyncEnum` to get available event types. */ webhookEvents?: Maybe>; /** 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. */ @@ -24761,6 +23902,7 @@ export type QueryCategoriesArgs = { export type QueryCategoryArgs = { id?: InputMaybe; slug?: InputMaybe; + slugLanguageCode?: InputMaybe; }; @@ -24799,6 +23941,7 @@ export type QueryCollectionArgs = { channel?: InputMaybe; id?: InputMaybe; slug?: InputMaybe; + slugLanguageCode?: InputMaybe; }; @@ -24820,7 +23963,9 @@ export type QueryCustomersArgs = { filter?: InputMaybe; first?: InputMaybe; last?: InputMaybe; + search?: InputMaybe; sortBy?: InputMaybe; + where?: InputMaybe; }; @@ -24843,7 +23988,9 @@ export type QueryDraftOrdersArgs = { filter?: InputMaybe; first?: InputMaybe; last?: InputMaybe; + search?: InputMaybe; sortBy?: InputMaybe; + where?: InputMaybe; }; @@ -24949,7 +24096,9 @@ export type QueryOrdersArgs = { filter?: InputMaybe; first?: InputMaybe; last?: InputMaybe; + search?: InputMaybe; sortBy?: InputMaybe; + where?: InputMaybe; }; @@ -24960,8 +24109,10 @@ export type QueryOrdersTotalArgs = { export type QueryPageArgs = { + channel?: InputMaybe; id?: InputMaybe; slug?: InputMaybe; + slugLanguageCode?: InputMaybe; }; @@ -24983,10 +24134,13 @@ export type QueryPageTypesArgs = { export type QueryPagesArgs = { after?: InputMaybe; before?: InputMaybe; + channel?: InputMaybe; filter?: InputMaybe; first?: InputMaybe; last?: InputMaybe; + search?: InputMaybe; sortBy?: InputMaybe; + where?: InputMaybe; }; @@ -25039,6 +24193,7 @@ export type QueryProductArgs = { externalReference?: InputMaybe; id?: InputMaybe; slug?: InputMaybe; + slugLanguageCode?: InputMaybe; }; @@ -25073,6 +24228,7 @@ export type QueryProductVariantsArgs = { first?: InputMaybe; ids?: InputMaybe>; last?: InputMaybe; + search?: InputMaybe; sortBy?: InputMaybe; where?: InputMaybe; }; @@ -25214,6 +24370,15 @@ export type QueryTransactionArgs = { }; +export type QueryTransactionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + where?: InputMaybe; +}; + + export type QueryTranslationArgs = { id: Scalars['ID']['input']; kind: TranslatableKinds; @@ -25288,10 +24453,17 @@ export type ReducedRate = { rateType: Scalars['String']['output']; }; +/** + * 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. + */ +export type ReferenceType = PageType | ProductType; + /** 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. */ export type RefreshToken = { __typename?: 'RefreshToken'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** JWT token, required to authenticate. */ @@ -25300,6 +24472,83 @@ export type RefreshToken = { user?: Maybe; }; +/** + * 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. + * + * Added in Saleor 3.22. + * + * Requires one of the following permissions: MANAGE_SETTINGS. + */ +export type RefundReasonReferenceTypeClear = { + __typename?: 'RefundReasonReferenceTypeClear'; + errors: Array; + /** Refund settings. */ + refundSettings: RefundSettings; + /** @deprecated Use `errors` field instead. */ + refundSettingsErrors: Array; +}; + +export type RefundReasonReferenceTypeClearError = { + __typename?: 'RefundReasonReferenceTypeClearError'; + /** Failed to clear refund reason reference type */ + code: RefundSettingsErrorCode; + /** 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; +}; + +/** + * Refund related settings from site settings. + * + * Added in Saleor 3.22. + */ +export type RefundSettings = { + __typename?: 'RefundSettings'; + /** Model type used for refund reasons. */ + reasonReferenceType?: Maybe; +}; + +export type RefundSettingsErrorCode = + | 'GRAPHQL_ERROR' + | 'INVALID' + | 'REQUIRED'; + +/** + * Update refund settings across all channels. + * + * Added in Saleor 3.22. + * + * Requires one of the following permissions: MANAGE_SETTINGS. + */ +export type RefundSettingsUpdate = { + __typename?: 'RefundSettingsUpdate'; + errors: Array; + /** Refund settings. */ + refundSettings: RefundSettings; + /** @deprecated Use `errors` field instead. */ + refundSettingsErrors: Array; +}; + +export type RefundSettingsUpdateError = { + __typename?: 'RefundSettingsUpdateError'; + /** Failed to update Refund Settings */ + code: RefundSettingsErrorCode; + /** 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 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. + * + * Added in Saleor 3.22. + */ + refundReasonReferenceType: Scalars['ID']['input']; +}; + export type ReorderInput = { /** The ID of the item to move. */ id: Scalars['ID']['input']; @@ -25322,7 +24571,7 @@ export type ReportingPeriod = */ export type RequestEmailChange = { __typename?: 'RequestEmailChange'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** A user instance. */ @@ -25339,17 +24588,15 @@ export type RequestEmailChange = { */ export type RequestPasswordReset = { __typename?: 'RequestPasswordReset'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; }; -/** An enumeration. */ export type RewardTypeEnum = | 'GIFT' | 'SUBTOTAL_DISCOUNT'; -/** An enumeration. */ export type RewardValueTypeEnum = | 'FIXED' | 'PERCENTAGE'; @@ -25357,7 +24604,7 @@ export type RewardValueTypeEnum = /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type Sale = Node & ObjectWithMetadata & { __typename?: 'Sale'; @@ -25391,15 +24638,9 @@ export type Sale = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** The name of the sale. */ name: Scalars['String']['output']; @@ -25409,15 +24650,9 @@ export type Sale = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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 products this sale applies to. @@ -25436,8 +24671,6 @@ export type Sale = Node & ObjectWithMetadata & { /** * List of product variants this sale applies to. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. */ variants?: Maybe; @@ -25447,7 +24680,7 @@ export type Sale = Node & ObjectWithMetadata & { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type SaleCategoriesArgs = { after?: InputMaybe; @@ -25460,7 +24693,7 @@ export type SaleCategoriesArgs = { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type SaleCollectionsArgs = { after?: InputMaybe; @@ -25473,7 +24706,7 @@ export type SaleCollectionsArgs = { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type SaleMetafieldArgs = { key: Scalars['String']['input']; @@ -25483,7 +24716,7 @@ export type SaleMetafieldArgs = { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type SaleMetafieldsArgs = { keys?: InputMaybe>; @@ -25493,7 +24726,7 @@ export type SaleMetafieldsArgs = { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type SalePrivateMetafieldArgs = { key: Scalars['String']['input']; @@ -25503,7 +24736,7 @@ export type SalePrivateMetafieldArgs = { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type SalePrivateMetafieldsArgs = { keys?: InputMaybe>; @@ -25513,7 +24746,7 @@ export type SalePrivateMetafieldsArgs = { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type SaleProductsArgs = { after?: InputMaybe; @@ -25526,7 +24759,7 @@ export type SaleProductsArgs = { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type SaleTranslationArgs = { languageCode: LanguageCodeEnum; @@ -25536,7 +24769,7 @@ export type SaleTranslationArgs = { /** * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. + * DEPRECATED: this type will be removed. Use `Promotion` type instead. */ export type SaleVariantsArgs = { after?: InputMaybe; @@ -25548,8 +24781,6 @@ export type SaleVariantsArgs = { /** * Adds products, categories, collections to a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionRuleCreate` mutation instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -25557,7 +24788,7 @@ export type SaleVariantsArgs = { */ export type SaleAddCatalogues = { __typename?: 'SaleAddCatalogues'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; /** Sale of which catalogue IDs will be modified. */ @@ -25576,7 +24807,7 @@ export type SaleBulkDelete = { __typename?: 'SaleBulkDelete'; /** Returns how many objects were affected. */ count: Scalars['Int']['output']; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; }; @@ -25584,7 +24815,7 @@ export type SaleBulkDelete = { /** * Represents sale channel listing. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `PromotionRule` type instead. + * DEPRECATED: this type will be removed. Use `PromotionRule` type instead. */ export type SaleChannelListing = Node & { __typename?: 'SaleChannelListing'; @@ -25615,13 +24846,11 @@ export type SaleChannelListingInput = { /** * Manage sale's availability in channels. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionRuleCreate` or `promotionRuleUpdate` mutations instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. */ export type SaleChannelListingUpdate = { __typename?: 'SaleChannelListingUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; /** An updated sale instance. */ @@ -25648,8 +24877,6 @@ export type SaleCountableEdge = { /** * Creates a new sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionCreate` mutation instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -25657,7 +24884,7 @@ export type SaleCountableEdge = { */ export type SaleCreate = { __typename?: 'SaleCreate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; sale?: Maybe; @@ -25666,9 +24893,7 @@ export type SaleCreate = { /** * Event sent when new sale is created. * - * Added in Saleor 3.2. - * - * DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionCreated` event instead. + * DEPRECATED: this event will be removed. Use `PromotionCreated` event instead. */ export type SaleCreated = Event & { __typename?: 'SaleCreated'; @@ -25688,9 +24913,7 @@ export type SaleCreated = Event & { /** * Event sent when new sale is created. * - * Added in Saleor 3.2. - * - * DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionCreated` event instead. + * DEPRECATED: this event will be removed. Use `PromotionCreated` event instead. */ export type SaleCreatedSaleArgs = { channel?: InputMaybe; @@ -25699,8 +24922,6 @@ export type SaleCreatedSaleArgs = { /** * Deletes a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionDelete` mutation instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -25708,7 +24929,7 @@ export type SaleCreatedSaleArgs = { */ export type SaleDelete = { __typename?: 'SaleDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; sale?: Maybe; @@ -25717,9 +24938,7 @@ export type SaleDelete = { /** * Event sent when sale is deleted. * - * Added in Saleor 3.2. - * - * DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionDeleted` event instead. + * DEPRECATED: this event will be removed. Use `PromotionDeleted` event instead. */ export type SaleDeleted = Event & { __typename?: 'SaleDeleted'; @@ -25739,9 +24958,7 @@ export type SaleDeleted = Event & { /** * Event sent when sale is deleted. * - * Added in Saleor 3.2. - * - * DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionDeleted` event instead. + * DEPRECATED: this event will be removed. Use `PromotionDeleted` event instead. */ export type SaleDeletedSaleArgs = { channel?: InputMaybe; @@ -25779,8 +24996,6 @@ export type SaleInput = { /** * Removes products, categories, collections from a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionRuleUpdate` or `promotionRuleDelete` mutations instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -25788,7 +25003,7 @@ export type SaleInput = { */ export type SaleRemoveCatalogues = { __typename?: 'SaleRemoveCatalogues'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; /** Sale of which catalogue IDs will be modified. */ @@ -25796,11 +25011,11 @@ export type SaleRemoveCatalogues = { }; export type SaleSortField = - /** Sort sales by created at. */ + /** Sort sales by creation date. */ | 'CREATED_AT' /** Sort sales by end date. */ | 'END_DATE' - /** Sort sales by last modified at. */ + /** Sort sales by last modification date. */ | 'LAST_MODIFIED_AT' /** Sort sales by name. */ | 'NAME' @@ -25818,8 +25033,7 @@ export type SaleSortField = export type SaleSortingInput = { /** * Specifies the channel in which to sort the data. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. + * @deprecated Use root-level channel argument instead. */ channel?: InputMaybe; /** Specifies the direction in which to sort sales. */ @@ -25831,9 +25045,7 @@ export type SaleSortingInput = { /** * The event informs about the start or end of the sale. * - * Added in Saleor 3.5. - * - * DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionStarted` and `PromotionEnded` events instead. + * DEPRECATED: this event will be removed. Use `PromotionStarted` and `PromotionEnded` events instead. */ export type SaleToggle = Event & { __typename?: 'SaleToggle'; @@ -25843,11 +25055,7 @@ export type SaleToggle = Event & { issuingPrincipal?: Maybe; /** The application receiving the webhook. */ recipient?: Maybe; - /** - * The sale the event relates to. - * - * Added in Saleor 3.5. - */ + /** The sale the event relates to. */ sale?: Maybe; /** Saleor version that triggered the event. */ version?: Maybe; @@ -25857,9 +25065,7 @@ export type SaleToggle = Event & { /** * The event informs about the start or end of the sale. * - * Added in Saleor 3.5. - * - * DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionStarted` and `PromotionEnded` events instead. + * DEPRECATED: this event will be removed. Use `PromotionStarted` and `PromotionEnded` events instead. */ export type SaleToggleSaleArgs = { channel?: InputMaybe; @@ -25868,7 +25074,7 @@ export type SaleToggleSaleArgs = { /** * Represents sale's original translatable fields and related translations. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `PromotionTranslatableContent` instead. + * DEPRECATED: this type will be removed. Use `PromotionTranslatableContent` instead. */ export type SaleTranslatableContent = Node & { __typename?: 'SaleTranslatableContent'; @@ -25880,14 +25086,10 @@ export type SaleTranslatableContent = Node & { * Sales allow creating discounts for categories, collections or products and are visible to all the customers. * * Requires one of the following permissions: MANAGE_DISCOUNTS. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ sale?: Maybe; - /** - * The ID of the sale to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the sale to translate. */ saleId: Scalars['ID']['output']; /** Returns translated sale fields for the given language code. */ translation?: Maybe; @@ -25897,7 +25099,7 @@ export type SaleTranslatableContent = Node & { /** * Represents sale's original translatable fields and related translations. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `PromotionTranslatableContent` instead. + * DEPRECATED: this type will be removed. Use `PromotionTranslatableContent` instead. */ export type SaleTranslatableContentTranslationArgs = { languageCode: LanguageCodeEnum; @@ -25906,22 +25108,20 @@ export type SaleTranslatableContentTranslationArgs = { /** * Creates/updates translations for a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `PromotionTranslate` mutation instead. - * * Requires one of the following permissions: MANAGE_TRANSLATIONS. */ export type SaleTranslate = { __typename?: 'SaleTranslate'; errors: Array; sale?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; /** * Represents sale translations. * - * DEPRECATED: this type will be removed in Saleor 4.0. Use `PromotionTranslation` instead. + * DEPRECATED: this type will be removed. Use `PromotionTranslation` instead. */ export type SaleTranslation = Node & { __typename?: 'SaleTranslation'; @@ -25931,11 +25131,7 @@ export type SaleTranslation = Node & { language: LanguageDisplay; /** Translated name of sale. */ name?: Maybe; - /** - * Represents the sale fields to translate. - * - * Added in Saleor 3.14. - */ + /** Represents the sale fields to translate. */ translatableContent?: Maybe; }; @@ -25946,8 +25142,6 @@ export type SaleType = /** * Updates a sale. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionUpdate` mutation instead. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. * * Triggers the following webhook events: @@ -25956,7 +25150,7 @@ export type SaleType = */ export type SaleUpdate = { __typename?: 'SaleUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; sale?: Maybe; @@ -25965,9 +25159,7 @@ export type SaleUpdate = { /** * Event sent when sale is updated. * - * Added in Saleor 3.2. - * - * DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionUpdated` event instead. + * DEPRECATED: this event will be removed. Use `PromotionUpdated` event instead. */ export type SaleUpdated = Event & { __typename?: 'SaleUpdated'; @@ -25987,15 +25179,13 @@ export type SaleUpdated = Event & { /** * Event sent when sale is updated. * - * Added in Saleor 3.2. - * - * DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionUpdated` event instead. + * DEPRECATED: this event will be removed. Use `PromotionUpdated` event instead. */ export type SaleUpdatedSaleArgs = { channel?: InputMaybe; }; -/** Represents a custom attribute. */ +/** Represents an assigned attribute to an object. */ export type SelectedAttribute = { __typename?: 'SelectedAttribute'; /** Name of an attribute displayed in the interface. */ @@ -26007,10 +25197,6 @@ export type SelectedAttribute = { /** * Sends a notification confirmation. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_USER. * * Triggers the following webhook events: @@ -26032,7 +25218,6 @@ export type SendConfirmationEmailError = { message?: Maybe; }; -/** An enumeration. */ export type SendConfirmationEmailErrorCode = | 'ACCOUNT_CONFIRMED' | 'CONFIRMATION_ALREADY_REQUESTED' @@ -26049,7 +25234,7 @@ export type SeoInput = { /** Sets the user's password from the token sent by email using the RequestPasswordReset mutation. */ export type SetPassword = { __typename?: 'SetPassword'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; /** CSRF token required to re-generate access token. */ csrfToken?: Maybe; @@ -26076,7 +25261,6 @@ export type ShippingError = { warehouses?: Maybe>; }; -/** An enumeration. */ export type ShippingErrorCode = | 'ALREADY_EXISTS' | 'DUPLICATED_INPUT_ITEM' @@ -26087,11 +25271,7 @@ export type ShippingErrorCode = | 'REQUIRED' | 'UNIQUE'; -/** - * List shipping methods for checkout. - * - * Added in Saleor 3.6. - */ +/** List shipping methods for checkout. */ export type ShippingListMethodsForCheckout = Event & { __typename?: 'ShippingListMethodsForCheckout'; /** The checkout the event relates to. */ @@ -26102,11 +25282,7 @@ export type ShippingListMethodsForCheckout = Event & { issuingPrincipal?: Maybe; /** The application receiving the webhook. */ recipient?: Maybe; - /** - * Shipping methods that can be used with this checkout. - * - * Added in Saleor 3.6. - */ + /** Shipping methods that can be used with this checkout. */ shippingMethods?: Maybe>; /** Saleor version that triggered the event. */ version?: Maybe; @@ -26131,7 +25307,7 @@ export type ShippingMethod = Node & ObjectWithMetadata & { maximumOrderPrice?: Maybe; /** * Maximum order weight for this shipping method. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ maximumOrderWeight?: Maybe; /** Message connected to this shipping method. */ @@ -26152,7 +25328,7 @@ export type ShippingMethod = Node & ObjectWithMetadata & { minimumOrderPrice?: Maybe; /** * Minimum order weight for this shipping method. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ minimumOrderWeight?: Maybe; /** Shipping method name. */ @@ -26173,7 +25349,7 @@ export type ShippingMethod = Node & ObjectWithMetadata & { translation?: Maybe; /** * Type of the shipping method. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ type?: Maybe; }; @@ -26249,7 +25425,7 @@ export type ShippingMethodChannelListingInput = { export type ShippingMethodChannelListingUpdate = { __typename?: 'ShippingMethodChannelListingUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; /** An updated shipping method instance. */ shippingMethod?: Maybe; @@ -26285,14 +25461,10 @@ export type ShippingMethodTranslatableContent = Node & { * Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers. * * Requires one of the following permissions: MANAGE_SHIPPING. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ shippingMethod?: Maybe; - /** - * The ID of the shipping method to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the shipping method to translate. */ shippingMethodId: Scalars['ID']['output']; /** Returns translated shipping method fields for the given language code. */ translation?: Maybe; @@ -26319,11 +25491,7 @@ export type ShippingMethodTranslation = Node & { language: LanguageDisplay; /** Translated shipping method name. */ name?: Maybe; - /** - * Represents the shipping method fields to translate. - * - * Added in Saleor 3.14. - */ + /** Represents the shipping method fields to translate. */ translatableContent?: Maybe; }; @@ -26362,15 +25530,9 @@ export type ShippingMethodType = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Minimal number of days for delivery. */ minimumDeliveryDays?: Maybe; @@ -26388,15 +25550,9 @@ export type ShippingMethodType = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** * Tax class assigned to this shipping method. @@ -26449,16 +25605,11 @@ export type ShippingMethodTypeTranslationArgs = { languageCode: LanguageCodeEnum; }; -/** An enumeration. */ export type ShippingMethodTypeEnum = | 'PRICE' | 'WEIGHT'; -/** - * List of shipping methods available for the country. - * - * Added in Saleor 3.6. - */ +/** List of shipping methods available for the country. */ export type ShippingMethodsPerCountry = { __typename?: 'ShippingMethodsPerCountry'; /** The country code. */ @@ -26484,7 +25635,7 @@ export type ShippingPriceBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; }; @@ -26496,18 +25647,14 @@ export type ShippingPriceBulkDelete = { export type ShippingPriceCreate = { __typename?: 'ShippingPriceCreate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; shippingMethod?: Maybe; /** A shipping zone to which the shipping method belongs. */ shippingZone?: Maybe; }; -/** - * Event sent when new shipping price is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new shipping price is created. */ export type ShippingPriceCreated = Event & { __typename?: 'ShippingPriceCreated'; /** Time of the event. */ @@ -26525,21 +25672,13 @@ export type ShippingPriceCreated = Event & { }; -/** - * Event sent when new shipping price is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new shipping price is created. */ export type ShippingPriceCreatedShippingMethodArgs = { channel?: InputMaybe; }; -/** - * Event sent when new shipping price is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new shipping price is created. */ export type ShippingPriceCreatedShippingZoneArgs = { channel?: InputMaybe; }; @@ -26552,7 +25691,7 @@ export type ShippingPriceCreatedShippingZoneArgs = { export type ShippingPriceDelete = { __typename?: 'ShippingPriceDelete'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; /** A shipping method to delete. */ shippingMethod?: Maybe; @@ -26560,11 +25699,7 @@ export type ShippingPriceDelete = { shippingZone?: Maybe; }; -/** - * Event sent when shipping price is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping price is deleted. */ export type ShippingPriceDeleted = Event & { __typename?: 'ShippingPriceDeleted'; /** Time of the event. */ @@ -26582,21 +25717,13 @@ export type ShippingPriceDeleted = Event & { }; -/** - * Event sent when shipping price is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping price is deleted. */ export type ShippingPriceDeletedShippingMethodArgs = { channel?: InputMaybe; }; -/** - * Event sent when shipping price is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping price is deleted. */ export type ShippingPriceDeletedShippingZoneArgs = { channel?: InputMaybe; }; @@ -26609,7 +25736,7 @@ export type ShippingPriceDeletedShippingZoneArgs = { export type ShippingPriceExcludeProducts = { __typename?: 'ShippingPriceExcludeProducts'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; /** A shipping method with new list of excluded products. */ shippingMethod?: Maybe; @@ -26655,7 +25782,7 @@ export type ShippingPriceInput = { export type ShippingPriceRemoveProductFromExclude = { __typename?: 'ShippingPriceRemoveProductFromExclude'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; /** A shipping method with new list of excluded products. */ shippingMethod?: Maybe; @@ -26670,7 +25797,7 @@ export type ShippingPriceTranslate = { __typename?: 'ShippingPriceTranslate'; errors: Array; shippingMethod?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; @@ -26692,18 +25819,14 @@ export type ShippingPriceTranslationInput = { export type ShippingPriceUpdate = { __typename?: 'ShippingPriceUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; shippingMethod?: Maybe; /** A shipping zone to which the shipping method belongs. */ shippingZone?: Maybe; }; -/** - * Event sent when shipping price is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping price is updated. */ export type ShippingPriceUpdated = Event & { __typename?: 'ShippingPriceUpdated'; /** Time of the event. */ @@ -26721,21 +25844,13 @@ export type ShippingPriceUpdated = Event & { }; -/** - * Event sent when shipping price is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping price is updated. */ export type ShippingPriceUpdatedShippingMethodArgs = { channel?: InputMaybe; }; -/** - * Event sent when shipping price is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping price is updated. */ export type ShippingPriceUpdatedShippingZoneArgs = { channel?: InputMaybe; }; @@ -26759,15 +25874,9 @@ export type ShippingZone = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Shipping zone name. */ name: Scalars['String']['output']; @@ -26779,15 +25888,9 @@ export type ShippingZone = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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 shipping methods available for orders shipped to countries within this shipping zone. */ shippingMethods?: Maybe>; @@ -26829,7 +25932,7 @@ export type ShippingZoneBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; }; @@ -26858,7 +25961,7 @@ export type ShippingZoneCountableEdge = { export type ShippingZoneCreate = { __typename?: 'ShippingZoneCreate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; shippingZone?: Maybe; }; @@ -26878,11 +25981,7 @@ export type ShippingZoneCreateInput = { name?: InputMaybe; }; -/** - * Event sent when new shipping zone is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new shipping zone is created. */ export type ShippingZoneCreated = Event & { __typename?: 'ShippingZoneCreated'; /** Time of the event. */ @@ -26898,11 +25997,7 @@ export type ShippingZoneCreated = Event & { }; -/** - * Event sent when new shipping zone is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new shipping zone is created. */ export type ShippingZoneCreatedShippingZoneArgs = { channel?: InputMaybe; }; @@ -26915,16 +26010,12 @@ export type ShippingZoneCreatedShippingZoneArgs = { export type ShippingZoneDelete = { __typename?: 'ShippingZoneDelete'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; shippingZone?: Maybe; }; -/** - * Event sent when shipping zone is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping zone is deleted. */ export type ShippingZoneDeleted = Event & { __typename?: 'ShippingZoneDeleted'; /** Time of the event. */ @@ -26940,11 +26031,7 @@ export type ShippingZoneDeleted = Event & { }; -/** - * Event sent when shipping zone is deleted. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping zone is deleted. */ export type ShippingZoneDeletedShippingZoneArgs = { channel?: InputMaybe; }; @@ -26954,11 +26041,7 @@ export type ShippingZoneFilterInput = { search?: InputMaybe; }; -/** - * Event sent when shipping zone metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when shipping zone metadata is updated. */ export type ShippingZoneMetadataUpdated = Event & { __typename?: 'ShippingZoneMetadataUpdated'; /** Time of the event. */ @@ -26974,11 +26057,7 @@ export type ShippingZoneMetadataUpdated = Event & { }; -/** - * Event sent when shipping zone metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when shipping zone metadata is updated. */ export type ShippingZoneMetadataUpdatedShippingZoneArgs = { channel?: InputMaybe; }; @@ -26991,7 +26070,7 @@ export type ShippingZoneMetadataUpdatedShippingZoneArgs = { export type ShippingZoneUpdate = { __typename?: 'ShippingZoneUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shippingErrors: Array; shippingZone?: Maybe; }; @@ -27015,11 +26094,7 @@ export type ShippingZoneUpdateInput = { removeWarehouses?: InputMaybe>; }; -/** - * Event sent when shipping zone is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping zone is updated. */ export type ShippingZoneUpdated = Event & { __typename?: 'ShippingZoneUpdated'; /** Time of the event. */ @@ -27035,11 +26110,7 @@ export type ShippingZoneUpdated = Event & { }; -/** - * Event sent when shipping zone is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when shipping zone is updated. */ export type ShippingZoneUpdatedShippingZoneArgs = { channel?: InputMaybe; }; @@ -27050,8 +26121,6 @@ export type Shop = ObjectWithMetadata & { /** * Determines if user can login without confirmation when `enableAccountConfirmation` is enabled. * - * Added in Saleor 3.15. - * * Requires one of the following permissions: MANAGE_SETTINGS. */ allowLoginWithoutConfirmation?: Maybe; @@ -27078,14 +26147,12 @@ export type Shop = ObjectWithMetadata & { /** * List of all currencies supported by shop's channels. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. */ channelCurrencies: Array; /** * Charge taxes on shipping. - * @deprecated This field will be removed in Saleor 4.0. Use `ShippingMethodType.taxClass` to determine whether taxes are calculated for shipping methods; if a tax class is set, the taxes will be calculated, otherwise no tax rate will be applied. + * @deprecated 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. */ chargeTaxesOnShipping: Scalars['Boolean']['output']; /** Company address. */ @@ -27126,7 +26193,7 @@ export type Shop = ObjectWithMetadata & { description?: Maybe; /** * Display prices with tax in store. - * @deprecated This field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to determine whether to display gross or net prices. + * @deprecated Use `Channel.taxConfiguration` to determine whether to display gross or net prices. */ displayGrossPrices: Scalars['Boolean']['output']; /** Shop's domain data. */ @@ -27134,22 +26201,12 @@ export type Shop = ObjectWithMetadata & { /** * Determines if account confirmation by email is enabled. * - * Added in Saleor 3.14. - * * Requires one of the following permissions: MANAGE_SETTINGS. */ enableAccountConfirmationByEmail?: Maybe; - /** - * Allow to approve fulfillments which are unpaid. - * - * Added in Saleor 3.1. - */ + /** Allow to approve fulfillments which are unpaid. */ fulfillmentAllowUnpaid: Scalars['Boolean']['output']; - /** - * Automatically approve all new fulfillments. - * - * Added in Saleor 3.1. - */ + /** Automatically approve all new fulfillments. */ fulfillmentAutoApprove: Scalars['Boolean']['output']; /** Header text. */ headerText?: Maybe; @@ -27157,7 +26214,7 @@ export type Shop = ObjectWithMetadata & { id: Scalars['ID']['output']; /** * Include taxes in prices. - * @deprecated This field will be removed in Saleor 4.0. Use `Channel.taxConfiguration.pricesEnteredWithTax` to determine whether prices are entered with tax. + * @deprecated Use `Channel.taxConfiguration.pricesEnteredWithTax` to determine whether prices are entered with tax. */ includeTaxesInPrices: Scalars['Boolean']['output']; /** List of the shops's supported languages. */ @@ -27165,8 +26222,6 @@ export type Shop = ObjectWithMetadata & { /** * Default number of maximum line quantity in single checkout (per single checkout line). * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_SETTINGS. */ limitQuantityPerCheckout?: Maybe; @@ -27174,7 +26229,7 @@ export type Shop = ObjectWithMetadata & { * Resource limitations and current usage if any set for a shop * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER. - * @deprecated This field will be removed in Saleor 4.0. + * @deprecated Field no longer supported */ limits: LimitInfo; /** List of public metadata items. Can be accessed without permissions. */ @@ -27206,24 +26261,16 @@ export type Shop = ObjectWithMetadata & { /** * Default number of minutes stock will be reserved for anonymous checkout or null when stock reservation is disabled. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_SETTINGS. */ reserveStockDurationAnonymousUser?: Maybe; /** * Default number of minutes stock will be reserved for authenticated checkout or null when stock reservation is disabled. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_SETTINGS. */ reserveStockDurationAuthenticatedUser?: Maybe; - /** - * Minor Saleor API version. - * - * Added in Saleor 3.5. - */ + /** Minor Saleor API version. */ schemaVersion: Scalars['String']['output']; /** * List of staff notification recipients. @@ -27235,6 +26282,13 @@ export type Shop = ObjectWithMetadata & { trackInventoryByDefault?: Maybe; /** Returns translated shop fields for the given language code. */ translation?: Maybe; + /** + * 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 Field no longer supported + */ + useLegacyUpdateWebhookEmission?: Maybe; /** * Saleor API version. * @@ -27304,15 +26358,13 @@ export type ShopAddressUpdate = { errors: Array; /** Updated shop. */ shop?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shopErrors: Array; }; /** * Updates site domain of the shop. * - * DEPRECATED: this mutation will be removed in Saleor 4.0. Use `PUBLIC_URL` environment variable instead. - * * Requires one of the following permissions: MANAGE_SETTINGS. */ export type ShopDomainUpdate = { @@ -27320,7 +26372,7 @@ export type ShopDomainUpdate = { errors: Array; /** Updated shop. */ shop?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shopErrors: Array; }; @@ -27334,7 +26386,6 @@ export type ShopError = { message?: Maybe; }; -/** An enumeration. */ export type ShopErrorCode = | 'ALREADY_EXISTS' | 'CANNOT_FETCH_TAX_RATES' @@ -27354,15 +26405,11 @@ export type ShopFetchTaxRates = { errors: Array; /** Updated shop. */ shop?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shopErrors: Array; }; -/** - * Event sent when shop metadata is updated. - * - * Added in Saleor 3.15. - */ +/** Event sent when shop metadata is updated. */ export type ShopMetadataUpdated = Event & { __typename?: 'ShopMetadataUpdated'; /** Time of the event. */ @@ -27378,18 +26425,13 @@ export type ShopMetadataUpdated = Event & { }; export type ShopSettingsInput = { - /** - * Enable possibility to login without account confirmation. - * - * Added in Saleor 3.15. - */ + /** Enable possibility to login without account confirmation. */ allowLoginWithoutConfirmation?: InputMaybe; /** Enable automatic fulfillment for all digital products. */ automaticFulfillmentDigitalProducts?: InputMaybe; /** * Charge taxes on shipping. - * - * DEPRECATED: this field will be removed in Saleor 4.0. To enable taxes for a shipping method, assign a tax class to the shipping method with `shippingPriceCreate` or `shippingPriceUpdate` mutations. + * @deprecated To enable taxes for a shipping method, assign a tax class to the shipping method with `shippingPriceCreate` or `shippingPriceUpdate` mutations. */ chargeTaxesOnShipping?: InputMaybe; /** URL of a view where customers can set their password. */ @@ -27408,68 +26450,49 @@ export type ShopSettingsInput = { description?: InputMaybe; /** * Display prices with tax in store. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `taxConfigurationUpdate` mutation to configure this setting per channel or country. + * @deprecated Use `taxConfigurationUpdate` mutation to configure this setting per channel or country. */ displayGrossPrices?: InputMaybe; - /** - * Enable automatic account confirmation by email. - * - * Added in Saleor 3.14. - */ + /** Enable automatic account confirmation by email. */ enableAccountConfirmationByEmail?: InputMaybe; - /** - * Enable ability to approve fulfillments which are unpaid. - * - * Added in Saleor 3.1. - */ + /** Enable ability to approve fulfillments which are unpaid. */ fulfillmentAllowUnpaid?: InputMaybe; - /** - * Enable automatic approval of all new fulfillments. - * - * Added in Saleor 3.1. - */ + /** Enable automatic approval of all new fulfillments. */ fulfillmentAutoApprove?: InputMaybe; /** Header text. */ headerText?: InputMaybe; /** * Include taxes in prices. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `taxConfigurationUpdate` mutation to configure this setting per channel or country. + * @deprecated Use `taxConfigurationUpdate` mutation to configure this setting per channel or country. */ includeTaxesInPrices?: InputMaybe; - /** - * Default number of maximum line quantity in single checkout. Minimum possible value is 1, default value is 50. - * - * Added in Saleor 3.1. - */ + /** Default number of maximum line quantity in single checkout. Minimum possible value is 1, default value is 50. */ limitQuantityPerCheckout?: InputMaybe; /** - * Shop public metadata. + * Shop public metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.15. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** - * Shop private metadata. + * Shop private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.15. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; - /** - * Default number of minutes stock will be reserved for anonymous checkout. Enter 0 or null to disable. - * - * Added in Saleor 3.1. - */ + /** Default number of minutes stock will be reserved for anonymous checkout. Enter 0 or null to disable. */ reserveStockDurationAnonymousUser?: InputMaybe; - /** - * Default number of minutes stock will be reserved for authenticated checkout. Enter 0 or null to disable. - * - * Added in Saleor 3.1. - */ + /** Default number of minutes stock will be reserved for authenticated checkout. Enter 0 or null to disable. */ reserveStockDurationAuthenticatedUser?: InputMaybe; /** This field is used as a default value for `ProductVariant.trackInventory`. */ trackInventoryByDefault?: InputMaybe; + /** + * 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 Field no longer supported + */ + useLegacyUpdateWebhookEmission?: InputMaybe; }; /** @@ -27482,7 +26505,7 @@ export type ShopSettingsTranslate = { errors: Array; /** Updated shop settings. */ shop?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; }; @@ -27504,7 +26527,7 @@ export type ShopSettingsUpdate = { errors: Array; /** Updated shop. */ shop?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shopErrors: Array; }; @@ -27541,7 +26564,7 @@ export type StaffBulkDelete = { /** Returns how many objects were affected. */ count: Scalars['Int']['output']; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ staffErrors: Array; }; @@ -27558,7 +26581,7 @@ export type StaffBulkDelete = { export type StaffCreate = { __typename?: 'StaffCreate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ staffErrors: Array; user?: Maybe; }; @@ -27576,28 +26599,24 @@ export type StaffCreateInput = { /** Family name. */ lastName?: InputMaybe; /** - * Fields required to update the user metadata. + * Fields required to update the user metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** A note about the user. */ note?: InputMaybe; /** - * Fields required to update the user private metadata. + * Fields required to update the user private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** URL of a view where users should be redirected to set the password. URL in RFC 1808 format. */ redirectUrl?: InputMaybe; }; -/** - * Event sent when new staff user is created. - * - * Added in Saleor 3.5. - */ +/** Event sent when new staff user is created. */ export type StaffCreated = Event & { __typename?: 'StaffCreated'; /** Time of the event. */ @@ -27623,16 +26642,12 @@ export type StaffCreated = Event & { export type StaffDelete = { __typename?: 'StaffDelete'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ staffErrors: Array; user?: Maybe; }; -/** - * Event sent when staff user is deleted. - * - * Added in Saleor 3.5. - */ +/** Event sent when staff user is deleted. */ export type StaffDeleted = Event & { __typename?: 'StaffDeleted'; /** Time of the event. */ @@ -27693,20 +26708,20 @@ export type StaffNotificationRecipient = Node & { export type StaffNotificationRecipientCreate = { __typename?: 'StaffNotificationRecipientCreate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shopErrors: Array; staffNotificationRecipient?: Maybe; }; /** - * Delete staff notification recipient. + * Deletes staff notification recipient. * * Requires one of the following permissions: MANAGE_SETTINGS. */ export type StaffNotificationRecipientDelete = { __typename?: 'StaffNotificationRecipientDelete'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shopErrors: Array; staffNotificationRecipient?: Maybe; }; @@ -27728,16 +26743,12 @@ export type StaffNotificationRecipientInput = { export type StaffNotificationRecipientUpdate = { __typename?: 'StaffNotificationRecipientUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ shopErrors: Array; staffNotificationRecipient?: Maybe; }; -/** - * Event sent when setting a new password for staff is requested. - * - * Added in Saleor 3.15. - */ +/** Event sent when setting a new password for staff is requested. */ export type StaffSetPasswordRequested = Event & { __typename?: 'StaffSetPasswordRequested'; /** The channel data. */ @@ -27771,7 +26782,7 @@ export type StaffSetPasswordRequested = Event & { export type StaffUpdate = { __typename?: 'StaffUpdate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ staffErrors: Array; user?: Maybe; }; @@ -27789,28 +26800,24 @@ export type StaffUpdateInput = { /** Family name. */ lastName?: InputMaybe; /** - * Fields required to update the user metadata. + * Fields required to update the user metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** A note about the user. */ note?: InputMaybe; /** - * Fields required to update the user private metadata. + * Fields required to update the user private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** List of permission group IDs from which user should be unassigned. */ removeGroups?: InputMaybe>; }; -/** - * Event sent when staff user is updated. - * - * Added in Saleor 3.5. - */ +/** Event sent when staff user is updated. */ export type StaffUpdated = Event & { __typename?: 'StaffUpdated'; /** Time of the event. */ @@ -27875,10 +26882,6 @@ export type StockBulkResult = { /** * 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. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: MANAGE_PRODUCTS. * * Triggers the following webhook events: @@ -27903,7 +26906,6 @@ export type StockBulkUpdateError = { message?: Maybe; }; -/** An enumeration. */ export type StockBulkUpdateErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' @@ -27950,7 +26952,6 @@ export type StockError = { message?: Maybe; }; -/** An enumeration. */ export type StockErrorCode = | 'ALREADY_EXISTS' | 'GRAPHQL_ERROR' @@ -27971,11 +26972,7 @@ export type StockInput = { warehouse: Scalars['ID']['input']; }; -/** - * Represents the channel stock settings. - * - * Added in Saleor 3.7. - */ +/** Represents the channel stock settings. */ export type StockSettings = { __typename?: 'StockSettings'; /** Allocation strategy defines the preference of warehouses for allocations and reservations. */ @@ -28015,13 +27012,7 @@ export type StorePaymentMethodEnum = /** On session storage type. The payment is stored only to be reused when the customer is present in the checkout flow. */ | 'ON_SESSION'; -/** - * Represents a payment method stored for user (tokenized) in payment gateway. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents a payment method stored for user (tokenized) in payment gateway. */ export type StoredPaymentMethod = { __typename?: 'StoredPaymentMethod'; /** Stored credit card details if available. */ @@ -28041,13 +27032,7 @@ export type StoredPaymentMethod = { type: Scalars['String']['output']; }; -/** - * Event sent when user requests to delete a payment method. - * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when user requests to delete a payment method. */ export type StoredPaymentMethodDeleteRequested = Event & { __typename?: 'StoredPaymentMethodDeleteRequested'; /** Channel related to the requested delete action. */ @@ -28069,10 +27054,6 @@ export type StoredPaymentMethodDeleteRequested = Event & { /** * Request to delete a stored payment method on payment provider side. * - * Added in Saleor 3.16. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_USER. * * Triggers the following webhook events: @@ -28085,7 +27066,6 @@ export type StoredPaymentMethodRequestDelete = { result: StoredPaymentMethodRequestDeleteResult; }; -/** An enumeration. */ export type StoredPaymentMethodRequestDeleteErrorCode = | 'CHANNEL_INACTIVE' | 'GATEWAY_ERROR' @@ -28107,13 +27087,7 @@ export type StoredPaymentMethodRequestDeleteResult = | 'FAILED_TO_DELIVER' | 'SUCCESSFULLY_DELETED'; -/** - * Define the filtering options for string fields. - * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Define the filtering options for string fields. */ export type StringFilterInput = { /** The value equal to. */ eq?: InputMaybe; @@ -28123,6 +27097,48 @@ export type StringFilterInput = { export type Subscription = { __typename?: 'Subscription'; + /** Synchronous webhook for calculating checkout/order taxes. */ + calculateTaxes?: Maybe; + /** + * Event sent when new checkout is created. + * + * Added in Saleor 3.21. + * + * Note: this API is currently in Feature Preview and can be subject to changes at later point. + */ + checkoutCreated?: Maybe; + /** + * Event sent when checkout is fully authorized. + * + * Added in Saleor 3.21. + * + * Note: this API is currently in Feature Preview and can be subject to changes at later point. + */ + checkoutFullyAuthorized?: Maybe; + /** + * Event sent when checkout is fully-paid. + * + * Added in Saleor 3.21. + * + * Note: this API is currently in Feature Preview and can be subject to changes at later point. + */ + checkoutFullyPaid?: Maybe; + /** + * Event sent when checkout metadata is updated. + * + * Added in Saleor 3.21. + * + * Note: this API is currently in Feature Preview and can be subject to changes at later point. + */ + checkoutMetadataUpdated?: Maybe; + /** + * Event sent when checkout is updated. + * + * Added in Saleor 3.21. + * + * Note: this API is currently in Feature Preview and can be subject to changes at later point. + */ + checkoutUpdated?: Maybe; /** * Event sent when new draft order is created. * @@ -28147,11 +27163,7 @@ export type Subscription = { * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ draftOrderUpdated?: Maybe; - /** - * Look up subscription event. - * - * Added in Saleor 3.2. - */ + /** Look up subscription event. */ event?: Maybe; /** * Event sent when orders are imported. @@ -28252,6 +27264,36 @@ export type Subscription = { }; +export type SubscriptionCalculateTaxesArgs = { + deferIf?: InputMaybe>; +}; + + +export type SubscriptionCheckoutCreatedArgs = { + channels?: InputMaybe>; +}; + + +export type SubscriptionCheckoutFullyAuthorizedArgs = { + channels?: InputMaybe>; +}; + + +export type SubscriptionCheckoutFullyPaidArgs = { + channels?: InputMaybe>; +}; + + +export type SubscriptionCheckoutMetadataUpdatedArgs = { + channels?: InputMaybe>; +}; + + +export type SubscriptionCheckoutUpdatedArgs = { + channels?: InputMaybe>; +}; + + export type SubscriptionDraftOrderCreatedArgs = { channels?: InputMaybe>; }; @@ -28330,11 +27372,7 @@ export type TaxCalculationStrategy = | 'FLAT_RATES' | 'TAX_APP'; -/** - * Tax class is a named object used to define tax rates per country. Tax class can be assigned to product types, products and shipping methods to define their tax rates. - * - * Added in Saleor 3.9. - */ +/** 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. */ export type TaxClass = Node & ObjectWithMetadata & { __typename?: 'TaxClass'; /** Country-specific tax rates for this tax class. */ @@ -28347,15 +27385,9 @@ export type TaxClass = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Name of the tax class. */ name: Scalars['String']['output']; @@ -28365,54 +27397,32 @@ export type TaxClass = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; }; -/** - * Tax class is a named object used to define tax rates per country. Tax class can be assigned to product types, products and shipping methods to define their tax rates. - * - * Added in Saleor 3.9. - */ +/** 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. */ export type TaxClassMetafieldArgs = { key: Scalars['String']['input']; }; -/** - * Tax class is a named object used to define tax rates per country. Tax class can be assigned to product types, products and shipping methods to define their tax rates. - * - * Added in Saleor 3.9. - */ +/** 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. */ export type TaxClassMetafieldsArgs = { keys?: InputMaybe>; }; -/** - * Tax class is a named object used to define tax rates per country. Tax class can be assigned to product types, products and shipping methods to define their tax rates. - * - * Added in Saleor 3.9. - */ +/** 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. */ export type TaxClassPrivateMetafieldArgs = { key: Scalars['String']['input']; }; -/** - * Tax class is a named object used to define tax rates per country. Tax class can be assigned to product types, products and shipping methods to define their tax rates. - * - * Added in Saleor 3.9. - */ +/** 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. */ export type TaxClassPrivateMetafieldsArgs = { keys?: InputMaybe>; }; @@ -28434,11 +27444,7 @@ export type TaxClassCountableEdge = { node: TaxClass; }; -/** - * Tax rate for a country. When tax class is null, it represents the default tax rate for that country; otherwise it's a country tax rate specific to the given tax class. - * - * Added in Saleor 3.9. - */ +/** 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. */ export type TaxClassCountryRate = { __typename?: 'TaxClassCountryRate'; /** Country in which this tax rate applies. */ @@ -28450,9 +27456,7 @@ export type TaxClassCountryRate = { }; /** - * Create a tax class. - * - * Added in Saleor 3.9. + * Creates a tax class. * * Requires one of the following permissions: MANAGE_TAXES. */ @@ -28474,7 +27478,6 @@ export type TaxClassCreateError = { message?: Maybe; }; -/** An enumeration. */ export type TaxClassCreateErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' @@ -28488,9 +27491,7 @@ export type TaxClassCreateInput = { }; /** - * Delete a tax class. After deleting the tax class any products, product types or shipping methods using it are updated to use the default tax class. - * - * Added in Saleor 3.9. + * 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. * * Requires one of the following permissions: MANAGE_TAXES. */ @@ -28510,7 +27511,6 @@ export type TaxClassDeleteError = { message?: Maybe; }; -/** An enumeration. */ export type TaxClassDeleteErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' @@ -28541,9 +27541,7 @@ export type TaxClassSortingInput = { }; /** - * Update a tax class. - * - * Added in Saleor 3.9. + * Updates a tax class. * * Requires one of the following permissions: MANAGE_TAXES. */ @@ -28565,7 +27563,6 @@ export type TaxClassUpdateError = { message?: Maybe; }; -/** An enumeration. */ export type TaxClassUpdateErrorCode = | 'DUPLICATED_INPUT_ITEM' | 'GRAPHQL_ERROR' @@ -28581,11 +27578,7 @@ export type TaxClassUpdateInput = { updateCountryRates?: InputMaybe>; }; -/** - * Channel-specific tax configuration. - * - * Added in Saleor 3.9. - */ +/** Channel-specific tax configuration. */ export type TaxConfiguration = Node & ObjectWithMetadata & { __typename?: 'TaxConfiguration'; /** A channel to which the tax configuration applies to. */ @@ -28604,15 +27597,9 @@ export type TaxConfiguration = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Determines whether prices are entered with the tax included. */ pricesEnteredWithTax: Scalars['Boolean']['output']; @@ -28622,15 +27609,9 @@ export type TaxConfiguration = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** * 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`. @@ -28640,44 +27621,34 @@ export type TaxConfiguration = Node & ObjectWithMetadata & { taxAppId?: Maybe; /** 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?: Maybe; + /** + * 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?: Maybe; }; -/** - * Channel-specific tax configuration. - * - * Added in Saleor 3.9. - */ +/** Channel-specific tax configuration. */ export type TaxConfigurationMetafieldArgs = { key: Scalars['String']['input']; }; -/** - * Channel-specific tax configuration. - * - * Added in Saleor 3.9. - */ +/** Channel-specific tax configuration. */ export type TaxConfigurationMetafieldsArgs = { keys?: InputMaybe>; }; -/** - * Channel-specific tax configuration. - * - * Added in Saleor 3.9. - */ +/** Channel-specific tax configuration. */ export type TaxConfigurationPrivateMetafieldArgs = { key: Scalars['String']['input']; }; -/** - * Channel-specific tax configuration. - * - * Added in Saleor 3.9. - */ +/** Channel-specific tax configuration. */ export type TaxConfigurationPrivateMetafieldsArgs = { keys?: InputMaybe>; }; @@ -28704,11 +27675,7 @@ export type TaxConfigurationFilterInput = { metadata?: InputMaybe>; }; -/** - * Country-specific exceptions of a channel's tax configuration. - * - * Added in Saleor 3.9. - */ +/** Country-specific exceptions of a channel's tax configuration. */ export type TaxConfigurationPerCountry = { __typename?: 'TaxConfigurationPerCountry'; /** Determines whether taxes are charged in this country. */ @@ -28725,6 +27692,12 @@ export type TaxConfigurationPerCountry = { taxAppId?: Maybe; /** 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?: Maybe; + /** + * 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?: Maybe; }; export type TaxConfigurationPerCountryInput = { @@ -28742,12 +27715,16 @@ export type TaxConfigurationPerCountryInput = { taxAppId?: InputMaybe; /** 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?: InputMaybe; + /** + * 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. Default value is `False`.Can be used only with `taxCalculationStrategy` set to `FLAT_RATES`. + * + * Added in Saleor 3.21. + */ + useWeightedTaxForShipping?: InputMaybe; }; /** - * Update tax configuration for a channel. - * - * Added in Saleor 3.9. + * Updates tax configuration for a channel. * * Requires one of the following permissions: MANAGE_TAXES. */ @@ -28769,7 +27746,6 @@ export type TaxConfigurationUpdateError = { message?: Maybe; }; -/** An enumeration. */ export type TaxConfigurationUpdateErrorCode = | 'DUPLICATED_INPUT_ITEM' | 'GRAPHQL_ERROR' @@ -28795,13 +27771,15 @@ export type TaxConfigurationUpdateInput = { taxCalculationStrategy?: InputMaybe; /** List of tax country configurations to create or update (identified by a country code). */ updateCountriesConfiguration?: InputMaybe>; + /** + * 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. Default value is `False`.Can be used only with `taxCalculationStrategy` set to `FLAT_RATES`. + * + * Added in Saleor 3.21. + */ + useWeightedTaxForShipping?: InputMaybe; }; -/** - * Tax class rates grouped by country. - * - * Added in Saleor 3.9. - */ +/** Tax class rates grouped by country. */ export type TaxCountryConfiguration = { __typename?: 'TaxCountryConfiguration'; /** A country for which tax class rates are grouped. */ @@ -28813,8 +27791,6 @@ export type TaxCountryConfiguration = { /** * Remove all tax class rates for a specific country. * - * Added in Saleor 3.9. - * * Requires one of the following permissions: MANAGE_TAXES. */ export type TaxCountryConfigurationDelete = { @@ -28834,16 +27810,13 @@ export type TaxCountryConfigurationDeleteError = { message?: Maybe; }; -/** An enumeration. */ export type TaxCountryConfigurationDeleteErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' | 'NOT_FOUND'; /** - * Update tax class rates for a specific country. - * - * Added in Saleor 3.9. + * Updates tax class rates for a specific country. * * Requires one of the following permissions: MANAGE_TAXES. */ @@ -28866,7 +27839,6 @@ export type TaxCountryConfigurationUpdateError = { taxClassIds: Array; }; -/** An enumeration. */ export type TaxCountryConfigurationUpdateErrorCode = | 'CANNOT_CREATE_NEGATIVE_RATE' | 'GRAPHQL_ERROR' @@ -28877,8 +27849,6 @@ export type TaxCountryConfigurationUpdateErrorCode = /** * Exempt checkout or order from charging the taxes. When tax exemption is enabled, taxes won't be charged for the checkout or order. Taxes may still be calculated in cases when product prices are entered with the tax included and the net price needs to be known. * - * Added in Saleor 3.8. - * * Requires one of the following permissions: MANAGE_TAXES. */ export type TaxExemptionManage = { @@ -28897,7 +27867,6 @@ export type TaxExemptionManageError = { message?: Maybe; }; -/** An enumeration. */ export type TaxExemptionManageErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' @@ -29002,48 +27971,27 @@ export type TaxedMoneyRange = { stop?: Maybe; }; -/** - * Event sent when thumbnail is created. - * - * Added in Saleor 3.12. - */ +/** Event sent when thumbnail is created. */ export type ThumbnailCreated = Event & { __typename?: 'ThumbnailCreated'; - /** - * Thumbnail id. - * - * Added in Saleor 3.12. - */ + /** Thumbnail id. */ id?: Maybe; /** Time of the event. */ issuedAt?: Maybe; /** The user or application that triggered the event. */ issuingPrincipal?: Maybe; - /** - * Original media url. - * - * Added in Saleor 3.12. - */ + /** Original media url. */ mediaUrl?: Maybe; - /** - * Object the thumbnail refers to. - * - * Added in Saleor 3.12. - */ + /** Object the thumbnail refers to. */ objectId?: Maybe; /** The application receiving the webhook. */ recipient?: Maybe; - /** - * Thumbnail url. - * - * Added in Saleor 3.12. - */ + /** Thumbnail url. */ url?: Maybe; /** Saleor version that triggered the event. */ version?: Maybe; }; -/** An enumeration. */ export type ThumbnailFormatEnum = | 'AVIF' | 'ORIGINAL' @@ -29064,7 +28012,6 @@ export type TimePeriodInputType = { type: TimePeriodTypeEnum; }; -/** An enumeration. */ export type TimePeriodTypeEnum = | 'DAY' | 'MONTH' @@ -29090,7 +28037,10 @@ export type Transaction = Node & { created: Scalars['DateTime']['output']; /** Error associated with transaction, if any. */ error?: Maybe; - /** Response returned by payment gateway. */ + /** + * Response returned by payment gateway. + * @deprecated This field is a part of a legacy Payments API. Please use apps instead. + */ gatewayResponse: Scalars['JSONString']['output']; /** ID of the transaction. */ id: Scalars['ID']['output']; @@ -29108,13 +28058,9 @@ export type TransactionAction = { __typename?: 'TransactionAction'; /** Determines the action type. */ actionType: TransactionActionEnum; - /** Transaction request amount. Null when action type is VOID. */ - amount?: Maybe; - /** - * Currency code. - * - * Added in Saleor 3.16. - */ + /** Transaction request amount. */ + amount: Scalars['PositiveDecimal']['output']; + /** Currency code. */ currency: Scalars['String']['output']; }; @@ -29131,13 +28077,7 @@ export type TransactionActionEnum = | 'CHARGE' | 'REFUND'; -/** - * Event sent when transaction cancelation is requested. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when transaction cancelation is requested. */ export type TransactionCancelationRequested = Event & { __typename?: 'TransactionCancelationRequested'; /** Requested action data. */ @@ -29154,13 +28094,7 @@ export type TransactionCancelationRequested = Event & { version?: Maybe; }; -/** - * Event sent when transaction charge is requested. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when transaction charge is requested. */ export type TransactionChargeRequested = Event & { __typename?: 'TransactionChargeRequested'; /** Requested action data. */ @@ -29177,12 +28111,25 @@ export type TransactionChargeRequested = Event & { version?: Maybe; }; +export type TransactionCountableConnection = { + __typename?: 'TransactionCountableConnection'; + edges: Array; + /** Pagination data for this connection. */ + pageInfo: PageInfo; + /** A total count of items in the collection. */ + totalCount?: Maybe; +}; + +export type TransactionCountableEdge = { + __typename?: 'TransactionCountableEdge'; + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of the edge. */ + node: TransactionItem; +}; + /** - * Create transaction for checkout or order. - * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. + * Creates transaction for checkout or order. * * Requires one of the following permissions: HANDLE_PAYMENTS. */ @@ -29202,7 +28149,6 @@ export type TransactionCreateError = { message?: Maybe; }; -/** An enumeration. */ export type TransactionCreateErrorCode = | 'GRAPHQL_ERROR' | 'INCORRECT_CURRENCY' @@ -29214,11 +28160,7 @@ export type TransactionCreateErrorCode = export type TransactionCreateInput = { /** Amount authorized by this transaction. */ amountAuthorized?: InputMaybe; - /** - * Amount canceled by this transaction. - * - * Added in Saleor 3.13. - */ + /** Amount canceled by this transaction. */ amountCanceled?: InputMaybe; /** Amount charged by this transaction. */ amountCharged?: InputMaybe; @@ -29226,110 +28168,79 @@ export type TransactionCreateInput = { amountRefunded?: InputMaybe; /** List of all possible actions for the transaction */ availableActions?: InputMaybe>; - /** - * The url that will allow to redirect user to payment provider page with transaction event details. - * - * Added in Saleor 3.13. - */ + /** The url that will allow to redirect user to payment provider page with transaction event details. */ externalUrl?: InputMaybe; + /** The message of the transaction. */ + message?: InputMaybe; /** - * The message of the transaction. + * Payment public metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.13. + * Warning: never store sensitive information, including financial data such as credit card details. */ - message?: InputMaybe; - /** Payment public metadata. */ metadata?: InputMaybe>; + /** Payment name of the transaction. */ + name?: InputMaybe; /** - * Payment name of the transaction. + * Details of the payment method used for the transaction. * - * Added in Saleor 3.13. + * Added in Saleor 3.22. */ - name?: InputMaybe; - /** Payment private metadata. */ - privateMetadata?: InputMaybe>; + paymentMethodDetails?: InputMaybe; /** - * PSP Reference of the transaction. + * Payment private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.13. + * Warning: never store sensitive information, including financial data such as credit card details. */ + privateMetadata?: InputMaybe>; + /** PSP Reference of the transaction. */ pspReference?: InputMaybe; }; /** Represents transaction's event. */ export type TransactionEvent = Node & { __typename?: 'TransactionEvent'; - /** - * The amount related to this event. - * - * Added in Saleor 3.13. - */ + /** The amount related to this event. */ amount: Money; /** Date and time at which a transaction event was created. */ createdAt: Scalars['DateTime']['output']; - /** - * User or App that created the transaction event. - * - * Added in Saleor 3.13. - */ + /** User or App that created the transaction event. */ createdBy?: Maybe; - /** - * The url that will allow to redirect user to payment provider page with transaction details. - * - * Added in Saleor 3.13. - */ + /** The url that will allow to redirect user to payment provider page with transaction details. */ externalUrl: Scalars['String']['output']; /** The ID of the object. */ id: Scalars['ID']['output']; - /** - * Idempotency key assigned to the event. - * - * Added in Saleor 3.14. - */ + /** Idempotency key assigned to the event. */ idempotencyKey?: Maybe; - /** - * Message related to the transaction's event. - * - * Added in Saleor 3.13. - */ + /** Message related to the transaction's event. */ message: Scalars['String']['output']; - /** - * PSP reference of transaction. - * - * Added in Saleor 3.13. - */ + /** PSP reference of transaction. */ pspReference: Scalars['String']['output']; /** - * The type of action related to this event. + * Reason model of the transaction refund. * - * Added in Saleor 3.13. + * Added in Saleor 3.22. */ + reasonReference?: Maybe; + /** The type of action related to this event. */ type?: Maybe; }; export type TransactionEventInput = { - /** - * The message related to the event. - * - * Added in Saleor 3.13. - */ + /** The message related to the event. */ message?: InputMaybe; - /** - * PSP Reference related to this action. - * - * Added in Saleor 3.13. - */ + /** PSP Reference related to this action. */ pspReference?: InputMaybe; }; /** * Report the event for the transaction. * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app. + * + * Triggers the following webhook events: + * - TRANSACTION_ITEM_METADATA_UPDATED (async): Optionally called when transaction's metadata was updated. + * - 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. */ export type TransactionEventReport = { __typename?: 'TransactionEventReport'; @@ -29352,13 +28263,13 @@ export type TransactionEventReportError = { message?: Maybe; }; -/** An enumeration. */ export type TransactionEventReportErrorCode = | 'ALREADY_EXISTS' | 'GRAPHQL_ERROR' | 'INCORRECT_DETAILS' | 'INVALID' - | 'NOT_FOUND'; + | 'NOT_FOUND' + | 'REQUIRED'; /** * Represents possible event types. @@ -29407,6 +28318,20 @@ export type TransactionEventTypeEnum = | 'REFUND_REVERSE' | 'REFUND_SUCCESS'; +/** Filter input for transactions. */ +export type TransactionFilterInput = { + /** Filter by metadata fields of transactions. */ + metadata?: InputMaybe; + /** Filter by payment method details used to pay for the order. */ + paymentMethodDetails?: InputMaybe; + /** + * Filter by PSP reference of transactions. + * + * Added in Saleor 3.22. + */ + pspReference?: InputMaybe; +}; + /** * Determine the transaction flow strategy. * @@ -29415,15 +28340,9 @@ export type TransactionEventTypeEnum = */ export type TransactionFlowStrategyEnum = | 'AUTHORIZATION' - | 'CHARGE'; - -/** - * 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. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + | 'CHARGE'; + +/** 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. */ export type TransactionInitialize = { __typename?: 'TransactionInitialize'; /** The JSON data required to finalize the payment. */ @@ -29445,7 +28364,6 @@ export type TransactionInitializeError = { message?: Maybe; }; -/** An enumeration. */ export type TransactionInitializeErrorCode = | 'CHECKOUT_COMPLETION_IN_PROGRESS' | 'GRAPHQL_ERROR' @@ -29453,30 +28371,16 @@ export type TransactionInitializeErrorCode = | 'NOT_FOUND' | 'UNIQUE'; -/** - * Event sent when user starts processing the payment. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when user starts processing the payment. */ export type TransactionInitializeSession = Event & { __typename?: 'TransactionInitializeSession'; /** Action to proceed for the transaction */ action: TransactionProcessAction; - /** - * The customer's IP address. If not provided as a parameter in the mutation, Saleor will try to determine the customer's IP address on its own. - * - * Added in Saleor 3.16. - */ + /** The customer's IP address. If not provided as a parameter in the mutation, Saleor will try to determine the customer's IP address on its own. */ customerIpAddress?: Maybe; /** Payment gateway data in JSON format, received from storefront. */ data?: Maybe; - /** - * Idempotency key assigned to the transaction initialize. - * - * Added in Saleor 3.14. - */ + /** Idempotency key assigned to the transaction initialize. */ idempotencyKey: Scalars['String']['output']; /** Time of the event. */ issuedAt?: Maybe; @@ -29494,74 +28398,36 @@ export type TransactionInitializeSession = Event & { version?: Maybe; }; -/** - * Represents a payment transaction. - * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents a payment transaction. */ export type TransactionItem = Node & ObjectWithMetadata & { __typename?: 'TransactionItem'; /** List of actions that can be performed in the current state of a payment. */ actions: Array; - /** - * Total amount of ongoing authorization requests for the transaction. - * - * Added in Saleor 3.13. - */ + /** Total amount of ongoing authorization requests for the transaction. */ authorizePendingAmount: Money; /** Total amount authorized for this payment. */ authorizedAmount: Money; - /** - * Total amount of ongoing cancel requests for the transaction. - * - * Added in Saleor 3.13. - */ + /** Total amount of ongoing cancel requests for the transaction. */ cancelPendingAmount: Money; - /** - * Total amount canceled for this payment. - * - * Added in Saleor 3.13. - */ + /** Total amount canceled for this payment. */ canceledAmount: Money; - /** - * Total amount of ongoing charge requests for the transaction. - * - * Added in Saleor 3.13. - */ + /** Total amount of ongoing charge requests for the transaction. */ chargePendingAmount: Money; /** Total amount charged for this payment. */ chargedAmount: Money; - /** - * The related checkout. - * - * Added in Saleor 3.14. - */ + /** The related checkout. */ checkout?: Maybe; /** Date and time at which payment transaction was created. */ createdAt: Scalars['DateTime']['output']; - /** - * User or App that created the transaction. - * - * Added in Saleor 3.13. - */ + /** User or App that created the transaction. */ createdBy?: Maybe; /** List of all transaction's events. */ events: Array; - /** - * The url that will allow to redirect user to payment provider page with transaction details. - * - * Added in Saleor 3.13. - */ + /** The url that will allow to redirect user to payment provider page with transaction details. */ externalUrl: Scalars['String']['output']; /** The ID of the object. */ id: Scalars['ID']['output']; - /** - * Message related to the transaction. - * - * Added in Saleor 3.13. - */ + /** Message related to the transaction. */ message: Scalars['String']['output']; /** List of public metadata items. Can be accessed without permissions. */ metadata: Array; @@ -29569,121 +28435,79 @@ export type TransactionItem = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Date and time at which payment transaction was modified. */ modifiedAt: Scalars['DateTime']['output']; - /** - * Name of the transaction. - * - * Added in Saleor 3.13. - */ + /** Name of the transaction. */ name: Scalars['String']['output']; + /** The related order. */ + order?: Maybe; /** - * The related order. + * The payment method used for this transaction. * - * Added in Saleor 3.6. + * Added in Saleor 3.22. */ - order?: Maybe; + paymentMethodDetails?: Maybe; /** List of private metadata items. Requires staff permissions to access. */ privateMetadata: Array; /** * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; + /** PSP reference of transaction. */ + pspReference: Scalars['String']['output']; /** - * PSP reference of transaction. + * Reason of the refund. * - * Added in Saleor 3.13. + * Added in Saleor 3.22. */ - pspReference: Scalars['String']['output']; + reason?: Maybe; /** - * Total amount of ongoing refund requests for the transaction. + * Reason `Page` (Model) for refund. * - * Added in Saleor 3.13. + * Added in Saleor 3.22. */ + reasonReference?: Maybe; + /** Total amount of ongoing refund requests for the transaction. */ refundPendingAmount: Money; /** Total amount refunded for this payment. */ refundedAmount: Money; - /** - * The transaction token. - * - * Added in Saleor 3.14. - */ + /** The transaction token. */ token: Scalars['UUID']['output']; }; -/** - * Represents a payment transaction. - * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents a payment transaction. */ export type TransactionItemMetafieldArgs = { key: Scalars['String']['input']; }; -/** - * Represents a payment transaction. - * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents a payment transaction. */ export type TransactionItemMetafieldsArgs = { keys?: InputMaybe>; }; -/** - * Represents a payment transaction. - * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents a payment transaction. */ export type TransactionItemPrivateMetafieldArgs = { key: Scalars['String']['input']; }; -/** - * Represents a payment transaction. - * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Represents a payment transaction. */ export type TransactionItemPrivateMetafieldsArgs = { keys?: InputMaybe>; }; -/** - * Event sent when transaction item metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when transaction item metadata is updated. */ export type TransactionItemMetadataUpdated = Event & { __typename?: 'TransactionItemMetadataUpdated'; /** Time of the event. */ @@ -29698,7 +28522,6 @@ export type TransactionItemMetadataUpdated = Event & { version?: Maybe; }; -/** An enumeration. */ export type TransactionKind = | 'ACTION_TO_CONFIRM' | 'AUTH' @@ -29711,13 +28534,7 @@ export type TransactionKind = | 'REFUND_ONGOING' | 'VOID'; -/** - * Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. */ export type TransactionProcess = { __typename?: 'TransactionProcess'; /** The json data required to finalize the payment. */ @@ -29748,7 +28565,6 @@ export type TransactionProcessError = { message?: Maybe; }; -/** An enumeration. */ export type TransactionProcessErrorCode = | 'CHECKOUT_COMPLETION_IN_PROGRESS' | 'GRAPHQL_ERROR' @@ -29758,22 +28574,12 @@ export type TransactionProcessErrorCode = | 'NOT_FOUND' | 'TRANSACTION_ALREADY_PROCESSED'; -/** - * Event sent when user has additional payment action to process. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when user has additional payment action to process. */ export type TransactionProcessSession = Event & { __typename?: 'TransactionProcessSession'; /** Action to proceed for the transaction */ action: TransactionProcessAction; - /** - * The customer's IP address. If not provided as a parameter in the mutation, Saleor will try to determine the customer's IP address on its own. - * - * Added in Saleor 3.16. - */ + /** The customer's IP address. If not provided as a parameter in the mutation, Saleor will try to determine the customer's IP address on its own. */ customerIpAddress?: Maybe; /** Payment gateway data in JSON format, received from storefront. */ data?: Maybe; @@ -29793,13 +28599,7 @@ export type TransactionProcessSession = Event & { version?: Maybe; }; -/** - * Event sent when transaction refund is requested. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ +/** Event sent when transaction refund is requested. */ export type TransactionRefundRequested = Event & { __typename?: 'TransactionRefundRequested'; /** Requested action data. */ @@ -29807,8 +28607,6 @@ export type TransactionRefundRequested = Event & { /** * Granted refund related to refund request. * - * Added in Saleor 3.15. - * * Note: this API is currently in Feature Preview and can be subject to changes at later point. */ grantedRefund?: Maybe; @@ -29827,10 +28625,6 @@ export type TransactionRefundRequested = Event & { /** * Request an action for payment transaction. * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: HANDLE_PAYMENTS. */ export type TransactionRequestAction = { @@ -29849,20 +28643,16 @@ export type TransactionRequestActionError = { message?: Maybe; }; -/** An enumeration. */ export type TransactionRequestActionErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' | 'MISSING_TRANSACTION_ACTION_REQUEST_WEBHOOK' - | 'NOT_FOUND'; + | 'NOT_FOUND' + | 'REQUIRED'; /** * Request a refund for payment transaction based on granted refund. * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: HANDLE_PAYMENTS. */ export type TransactionRequestRefundForGrantedRefund = { @@ -29881,7 +28671,6 @@ export type TransactionRequestRefundForGrantedRefundError = { message?: Maybe; }; -/** An enumeration. */ export type TransactionRequestRefundForGrantedRefundErrorCode = | 'AMOUNT_GREATER_THAN_AVAILABLE' | 'GRAPHQL_ERROR' @@ -29894,10 +28683,6 @@ export type TransactionRequestRefundForGrantedRefundErrorCode = /** * Update transaction. * - * Added in Saleor 3.4. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app. */ export type TransactionUpdate = { @@ -29916,7 +28701,6 @@ export type TransactionUpdateError = { message?: Maybe; }; -/** An enumeration. */ export type TransactionUpdateErrorCode = | 'GRAPHQL_ERROR' | 'INCORRECT_CURRENCY' @@ -29928,11 +28712,7 @@ export type TransactionUpdateErrorCode = export type TransactionUpdateInput = { /** Amount authorized by this transaction. */ amountAuthorized?: InputMaybe; - /** - * Amount canceled by this transaction. - * - * Added in Saleor 3.13. - */ + /** Amount canceled by this transaction. */ amountCanceled?: InputMaybe; /** Amount charged by this transaction. */ amountCharged?: InputMaybe; @@ -29940,36 +28720,46 @@ export type TransactionUpdateInput = { amountRefunded?: InputMaybe; /** List of all possible actions for the transaction */ availableActions?: InputMaybe>; - /** - * The url that will allow to redirect user to payment provider page with transaction event details. - * - * Added in Saleor 3.13. - */ + /** The url that will allow to redirect user to payment provider page with transaction event details. */ externalUrl?: InputMaybe; + /** The message of the transaction. */ + message?: InputMaybe; /** - * The message of the transaction. + * Payment public metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.13. + * Warning: never store sensitive information, including financial data such as credit card details. */ - message?: InputMaybe; - /** Payment public metadata. */ metadata?: InputMaybe>; + /** Payment name of the transaction. */ + name?: InputMaybe; /** - * Payment name of the transaction. + * Details of the payment method used for the transaction. * - * Added in Saleor 3.13. + * Added in Saleor 3.22. */ - name?: InputMaybe; - /** Payment private metadata. */ - privateMetadata?: InputMaybe>; + paymentMethodDetails?: InputMaybe; /** - * PSP Reference of the transaction. + * Payment private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.13. + * Warning: never store sensitive information, including financial data such as credit card details. */ + privateMetadata?: InputMaybe>; + /** PSP Reference of the transaction. */ pspReference?: InputMaybe; }; +export type TransactionWhereInput = { + /** List of conditions that must be met. */ + AND?: InputMaybe>; + /** A list of conditions of which at least one must be met. */ + OR?: InputMaybe>; + /** Filter by app identifier. */ + appIdentifier?: InputMaybe; + ids?: InputMaybe>; + /** Filter by PSP reference. */ + pspReference?: InputMaybe; +}; + export type TranslatableItem = AttributeTranslatableContent | AttributeValueTranslatableContent | CategoryTranslatableContent | CollectionTranslatableContent | MenuItemTranslatableContent | PageTranslatableContent | ProductTranslatableContent | ProductVariantTranslatableContent | PromotionRuleTranslatableContent | PromotionTranslatableContent | SaleTranslatableContent | ShippingMethodTranslatableContent | VoucherTranslatableContent; export type TranslatableItemConnection = { @@ -30004,11 +28794,7 @@ export type TranslatableKinds = | 'VARIANT' | 'VOUCHER'; -/** - * Event sent when new translation is created. - * - * Added in Saleor 3.2. - */ +/** Event sent when new translation is created. */ export type TranslationCreated = Event & { __typename?: 'TranslationCreated'; /** Time of the event. */ @@ -30033,12 +28819,12 @@ export type TranslationError = { message?: Maybe; }; -/** An enumeration. */ export type TranslationErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' | 'NOT_FOUND' - | 'REQUIRED'; + | 'REQUIRED' + | 'UNIQUE'; export type TranslationInput = { /** @@ -30050,15 +28836,12 @@ export type TranslationInput = { name?: InputMaybe; seoDescription?: InputMaybe; seoTitle?: InputMaybe; + slug?: InputMaybe; }; export type TranslationTypes = AttributeTranslation | AttributeValueTranslation | CategoryTranslation | CollectionTranslation | MenuItemTranslation | PageTranslation | ProductTranslation | ProductVariantTranslation | PromotionRuleTranslation | PromotionTranslation | SaleTranslation | ShippingMethodTranslation | VoucherTranslation; -/** - * Event sent when translation is updated. - * - * Added in Saleor 3.2. - */ +/** Event sent when translation is updated. */ export type TranslationUpdated = Event & { __typename?: 'TranslationUpdated'; /** Time of the event. */ @@ -30073,40 +28856,56 @@ export type TranslationUpdated = Event & { version?: Maybe; }; +/** Define the filtering options for string fields. */ +export type UuidFilterInput = { + /** The value equal to. */ + eq?: InputMaybe; + /** The value included in. */ + oneOf?: InputMaybe>; +}; + export type UpdateInvoiceInput = { /** - * Fields required to update the invoice metadata. + * Fields required to update the invoice metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** Invoice number */ number?: InputMaybe; /** - * Fields required to update the invoice private metadata. + * Fields required to update the invoice private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** URL of an invoice to download. */ url?: InputMaybe; }; -/** Updates metadata of an object. To use it, you need to have access to the modified object. */ +/** + * Updates metadata of an object.Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ export type UpdateMetadata = { __typename?: 'UpdateMetadata'; errors: Array; item?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ metadataErrors: Array; }; -/** Updates private metadata of an object. To use it, you need to be an authenticated staff user or an app and have access to the modified object. */ +/** + * Updates private metadata of an object. Requires permissions to modify and to read the metadata of the object it's attached to. + * + * Warning: never store sensitive information, including financial data such as credit card details. + */ export type UpdatePrivateMetadata = { __typename?: 'UpdatePrivateMetadata'; errors: Array; item?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ metadataErrors: Array; }; @@ -30120,20 +28919,15 @@ export type UploadError = { message?: Maybe; }; -/** An enumeration. */ export type UploadErrorCode = - | 'GRAPHQL_ERROR'; + | 'GRAPHQL_ERROR' + | 'INVALID_FILE_TYPE' + | 'UNSUPPORTED_MIME_TYPE'; /** Represents user data. */ export type User = Node & ObjectWithMetadata & { __typename?: 'User'; - /** - * List of channels the user has access to. The sum of channels from all user groups. If at least one group has `restrictedAccessToChannels` set to False - all channels are returned. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** 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?: Maybe>; /** List of all user's addresses. */ addresses: Array
; @@ -30141,21 +28935,17 @@ export type User = Node & ObjectWithMetadata & { avatar?: Maybe; /** * Returns the last open checkout of this user. - * @deprecated This field will be removed in Saleor 4.0. Use the `checkoutTokens` field to fetch the user checkouts. + * @deprecated Use the `checkoutTokens` field to fetch the user checkouts. */ checkout?: Maybe; /** Returns the checkout ID's assigned to this user. */ checkoutIds?: Maybe>; /** * Returns the checkout UUID's assigned to this user. - * @deprecated This field will be removed in Saleor 4.0. Use `checkoutIds` instead. + * @deprecated Use `checkoutIds` instead. */ checkoutTokens?: Maybe>; - /** - * Returns checkouts assigned to this user. - * - * Added in Saleor 3.8. - */ + /** 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?: Maybe; /** The data when the user create account. */ dateJoined: Scalars['DateTime']['output']; @@ -30173,11 +28963,7 @@ export type User = Node & ObjectWithMetadata & { * Requires one of the following permissions: MANAGE_USERS, MANAGE_STAFF. */ events?: Maybe>; - /** - * External ID of this user. - * - * Added in Saleor 3.10. - */ + /** External ID of this user. */ externalReference?: Maybe; /** The given name of the address. */ firstName: Scalars['String']['output']; @@ -30187,11 +28973,7 @@ export type User = Node & ObjectWithMetadata & { id: Scalars['ID']['output']; /** Determine if the user is active. */ isActive: Scalars['Boolean']['output']; - /** - * Determines if user has confirmed email. - * - * Added in Saleor 3.15. - */ + /** Determines if user has confirmed email. */ isConfirmed: Scalars['Boolean']['output']; /** Determine if the user is a staff admin. */ isStaff: Scalars['Boolean']['output']; @@ -30207,15 +28989,9 @@ export type User = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** * A note about the customer. @@ -30223,7 +28999,7 @@ export type User = Node & ObjectWithMetadata & { * Requires one of the following permissions: MANAGE_USERS, MANAGE_STAFF. */ note?: Maybe; - /** List of user's orders. Requires one of the following permissions: MANAGE_STAFF, OWNER. */ + /** 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?: Maybe; /** List of user's permission groups. */ permissionGroups?: Maybe>; @@ -30233,31 +29009,13 @@ export type User = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; - /** - * Determine if user have restricted access to channels. False if at least one user group has `restrictedAccessToChannels` set to False. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Determine if user have restricted access to channels. False if at least one user group has `restrictedAccessToChannels` set to False. */ restrictedAccessToChannels: Scalars['Boolean']['output']; - /** - * 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. - * - * Added in Saleor 3.15. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** 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?: Maybe>; /** List of stored payment sources. The field returns a list of payment sources stored for payment plugins. */ storedPaymentSources?: Maybe>; @@ -30357,7 +29115,7 @@ export type UserStoredPaymentSourcesArgs = { */ export type UserAvatarDelete = { __typename?: 'UserAvatarDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** An updated user instance. */ @@ -30371,7 +29129,7 @@ export type UserAvatarDelete = { */ export type UserAvatarUpdate = { __typename?: 'UserAvatarUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** An updated user instance. */ @@ -30385,7 +29143,7 @@ export type UserAvatarUpdate = { */ export type UserBulkSetActive = { __typename?: 'UserBulkSetActive'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; /** Returns how many objects were affected. */ count: Scalars['Int']['output']; @@ -30418,11 +29176,7 @@ export type UserCreateInput = { defaultShippingAddress?: InputMaybe; /** The unique email address of the user. */ email?: InputMaybe; - /** - * External ID of the customer. - * - * Added in Saleor 3.10. - */ + /** External ID of the customer. */ externalReference?: InputMaybe; /** Given name. */ firstName?: InputMaybe; @@ -30430,12 +29184,7 @@ export type UserCreateInput = { isActive?: InputMaybe; /** * User account is confirmed. - * - * Added in Saleor 3.15. - * - * DEPRECATED: this field will be removed in Saleor 4.0. - * - * The user will be always set as unconfirmed. The confirmation will take place when the user sets the password. + * @deprecated The user will be always set as unconfirmed. The confirmation will take place when the user sets the password. */ isConfirmed?: InputMaybe; /** User language code. */ @@ -30443,17 +29192,17 @@ export type UserCreateInput = { /** Family name. */ lastName?: InputMaybe; /** - * Fields required to update the user metadata. + * Fields required to update the user metadata. Can be read by any API client authorized to read the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ metadata?: InputMaybe>; /** A note about the user. */ note?: InputMaybe; /** - * Fields required to update the user private metadata. + * Fields required to update the user private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. * - * Added in Saleor 3.14. + * Warning: never store sensitive information, including financial data such as credit card details. */ privateMetadata?: InputMaybe>; /** URL of a view where users should be redirected to set the password. URL in RFC 1808 format. */ @@ -30525,7 +29274,7 @@ export type VariantMediaAssign = { __typename?: 'VariantMediaAssign'; errors: Array; media?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; productVariant?: Maybe; }; @@ -30539,7 +29288,7 @@ export type VariantMediaUnassign = { __typename?: 'VariantMediaUnassign'; errors: Array; media?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ productErrors: Array; productVariant?: Maybe; }; @@ -30551,18 +29300,30 @@ export type VariantPricingInfo = { discount?: Maybe; /** * The discount amount in the local currency. - * @deprecated This field will be removed in Saleor 4.0. Always returns `null`. + * @deprecated Always returns `null`. */ discountLocalCurrency?: Maybe; + /** + * 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?: Maybe; /** Whether it is in sale or not. */ onSale?: Maybe; /** The price, with any discount subtracted. */ price?: Maybe; /** * The discounted price in the local currency. - * @deprecated This field will be removed in Saleor 4.0. Always returns `null`. + * @deprecated Always returns `null`. */ priceLocalCurrency?: Maybe; + /** + * The price prior to discount. + * + * Added in Saleor 3.21. + */ + pricePrior?: Maybe; /** The price without any discount. */ priceUndiscounted?: Maybe; }; @@ -30570,7 +29331,7 @@ export type VariantPricingInfo = { /** Verify JWT token. */ export type VerifyToken = { __typename?: 'VerifyToken'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ accountErrors: Array; errors: Array; /** Determine if token is valid or not. */ @@ -30581,7 +29342,6 @@ export type VerifyToken = { user?: Maybe; }; -/** An enumeration. */ export type VolumeUnitsEnum = | 'ACRE_FT' | 'ACRE_IN' @@ -30612,7 +29372,7 @@ export type Voucher = Node & ObjectWithMetadata & { * Requires one of the following permissions: MANAGE_DISCOUNTS. */ channelListings?: Maybe>; - /** The code of the voucher.This field will be removed in Saleor 4.0. */ + /** The code of the voucher. */ code?: Maybe; /** * List of codes available for this voucher. @@ -30644,15 +29404,9 @@ export type Voucher = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Determine minimum quantity of items for checkout. */ minCheckoutItemsQuantity?: Maybe; @@ -30668,15 +29422,9 @@ export type Voucher = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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 products this voucher applies to. @@ -30705,8 +29453,6 @@ export type Voucher = Node & ObjectWithMetadata & { /** * List of product variants this voucher applies to. * - * Added in Saleor 3.1. - * * Requires one of the following permissions: MANAGE_DISCOUNTS. */ variants?: Maybe; @@ -30797,7 +29543,7 @@ export type VoucherVariantsArgs = { */ export type VoucherAddCatalogues = { __typename?: 'VoucherAddCatalogues'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; /** Voucher of which catalogue IDs will be modified. */ @@ -30816,7 +29562,7 @@ export type VoucherBulkDelete = { __typename?: 'VoucherBulkDelete'; /** Returns how many objects were affected. */ count: Scalars['Int']['output']; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; }; @@ -30862,7 +29608,7 @@ export type VoucherChannelListingInput = { */ export type VoucherChannelListingUpdate = { __typename?: 'VoucherChannelListingUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; /** An updated voucher instance. */ @@ -30919,7 +29665,6 @@ export type VoucherCodeBulkDeleteError = { voucherCodes?: Maybe>; }; -/** An enumeration. */ export type VoucherCodeBulkDeleteErrorCode = | 'GRAPHQL_ERROR' | 'INVALID' @@ -31027,17 +29772,13 @@ export type VoucherCountableEdge = { */ export type VoucherCreate = { __typename?: 'VoucherCreate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; voucher?: Maybe; }; -/** - * Event sent when new voucher is created. - * - * Added in Saleor 3.4. - */ +/** Event sent when new voucher is created. */ export type VoucherCreated = Event & { __typename?: 'VoucherCreated'; /** Time of the event. */ @@ -31053,11 +29794,7 @@ export type VoucherCreated = Event & { }; -/** - * Event sent when new voucher is created. - * - * Added in Saleor 3.4. - */ +/** Event sent when new voucher is created. */ export type VoucherCreatedVoucherArgs = { channel?: InputMaybe; }; @@ -31072,17 +29809,13 @@ export type VoucherCreatedVoucherArgs = { */ export type VoucherDelete = { __typename?: 'VoucherDelete'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; voucher?: Maybe; }; -/** - * Event sent when voucher is deleted. - * - * Added in Saleor 3.4. - */ +/** Event sent when voucher is deleted. */ export type VoucherDeleted = Event & { __typename?: 'VoucherDeleted'; /** Time of the event. */ @@ -31098,11 +29831,7 @@ export type VoucherDeleted = Event & { }; -/** - * Event sent when voucher is deleted. - * - * Added in Saleor 3.4. - */ +/** Event sent when voucher is deleted. */ export type VoucherDeletedVoucherArgs = { channel?: InputMaybe; }; @@ -31137,7 +29866,10 @@ export type VoucherInput = { applyOncePerOrder?: InputMaybe; /** Categories discounted by the voucher. */ categories?: InputMaybe>; - /** Code to use the voucher. This field will be removed in Saleor 4.0. Use `addCodes` instead. */ + /** + * Code to use the voucher. + * @deprecated Use `addCodes` instead. + */ code?: InputMaybe; /** Collections discounted by the voucher. */ collections?: InputMaybe>; @@ -31171,19 +29903,11 @@ export type VoucherInput = { type?: InputMaybe; /** Limit number of times this voucher can be used in total. */ usageLimit?: InputMaybe; - /** - * Variants discounted by the voucher. - * - * Added in Saleor 3.1. - */ + /** Variants discounted by the voucher. */ variants?: InputMaybe>; }; -/** - * Event sent when voucher metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when voucher metadata is updated. */ export type VoucherMetadataUpdated = Event & { __typename?: 'VoucherMetadataUpdated'; /** Time of the event. */ @@ -31199,11 +29923,7 @@ export type VoucherMetadataUpdated = Event & { }; -/** - * Event sent when voucher metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when voucher metadata is updated. */ export type VoucherMetadataUpdatedVoucherArgs = { channel?: InputMaybe; }; @@ -31218,7 +29938,7 @@ export type VoucherMetadataUpdatedVoucherArgs = { */ export type VoucherRemoveCatalogues = { __typename?: 'VoucherRemoveCatalogues'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; /** Voucher of which catalogue IDs will be modified. */ @@ -31226,11 +29946,7 @@ export type VoucherRemoveCatalogues = { }; export type VoucherSortField = - /** - * Sort vouchers by code. - * - * DEPRECATED: this field will be removed in Saleor 4.0. - */ + /** Sort vouchers by code. */ | 'CODE' /** Sort vouchers by end date. */ | 'END_DATE' @@ -31262,8 +29978,7 @@ export type VoucherSortField = export type VoucherSortingInput = { /** * Specifies the channel in which to sort the data. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. + * @deprecated Use root-level channel argument instead. */ channel?: InputMaybe; /** Specifies the direction in which to sort vouchers. */ @@ -31285,14 +30000,10 @@ export type VoucherTranslatableContent = Node & { * 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. - * @deprecated This field will be removed in Saleor 4.0. Get model fields from the root level queries. + * @deprecated Get model fields from the root level queries. */ voucher?: Maybe; - /** - * The ID of the voucher to translate. - * - * Added in Saleor 3.14. - */ + /** The ID of the voucher to translate. */ voucherId: Scalars['ID']['output']; }; @@ -31310,7 +30021,7 @@ export type VoucherTranslatableContentTranslationArgs = { export type VoucherTranslate = { __typename?: 'VoucherTranslate'; errors: Array; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ translationErrors: Array; voucher?: Maybe; }; @@ -31324,11 +30035,7 @@ export type VoucherTranslation = Node & { language: LanguageDisplay; /** Translated voucher name. */ name?: Maybe; - /** - * Represents the voucher fields to translate. - * - * Added in Saleor 3.14. - */ + /** Represents the voucher fields to translate. */ translatableContent?: Maybe; }; @@ -31348,17 +30055,13 @@ export type VoucherTypeEnum = */ export type VoucherUpdate = { __typename?: 'VoucherUpdate'; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ discountErrors: Array; errors: Array; voucher?: Maybe; }; -/** - * Event sent when voucher is updated. - * - * Added in Saleor 3.4. - */ +/** Event sent when voucher is updated. */ export type VoucherUpdated = Event & { __typename?: 'VoucherUpdated'; /** Time of the event. */ @@ -31374,11 +30077,7 @@ export type VoucherUpdated = Event & { }; -/** - * Event sent when voucher is updated. - * - * Added in Saleor 3.4. - */ +/** Event sent when voucher is updated. */ export type VoucherUpdatedVoucherArgs = { channel?: InputMaybe; }; @@ -31386,26 +30085,18 @@ export type VoucherUpdatedVoucherArgs = { /** Represents warehouse. */ export type Warehouse = Node & ObjectWithMetadata & { __typename?: 'Warehouse'; - /** Address of the warehouse. */ - address: Address; - /** - * Click and collect options: local, all or disabled. - * - * Added in Saleor 3.1. - */ + /** Address of the warehouse. */ + address: Address; + /** Click and collect options: local, all or disabled. */ clickAndCollectOption: WarehouseClickAndCollectOptionEnum; /** * Warehouse company name. - * @deprecated This field will be removed in Saleor 4.0. Use `Address.companyName` instead. + * @deprecated Use `Address.companyName` instead. */ companyName: Scalars['String']['output']; /** Warehouse email. */ email: Scalars['String']['output']; - /** - * External ID of this warehouse. - * - * Added in Saleor 3.10. - */ + /** External ID of this warehouse. */ externalReference?: Maybe; /** The ID of the warehouse. */ id: Scalars['ID']['output']; @@ -31417,15 +30108,9 @@ export type Warehouse = Node & ObjectWithMetadata & { * A single key from public metadata. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ metafield?: Maybe; - /** - * Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - * - * Added in Saleor 3.3. - */ + /** Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. */ metafields?: Maybe; /** Warehouse name. */ name: Scalars['String']['output']; @@ -31435,15 +30120,9 @@ export type Warehouse = Node & ObjectWithMetadata & { * A single key from private metadata. Requires staff permissions to access. * * Tip: Use GraphQL aliases to fetch multiple keys. - * - * Added in Saleor 3.3. */ 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. - * - * Added in Saleor 3.3. - */ + /** 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; /** Shipping zones supported by the warehouse. */ shippingZones: ShippingZoneCountableConnection; @@ -31501,7 +30180,6 @@ export type WarehouseStocksArgs = { last?: InputMaybe; }; -/** An enumeration. */ export type WarehouseClickAndCollectOptionEnum = | 'ALL' | 'DISABLED' @@ -31525,7 +30203,7 @@ export type WarehouseCountableEdge = { }; /** - * Creates new warehouse. + * Creates a new warehouse. * * Requires one of the following permissions: MANAGE_PRODUCTS. */ @@ -31533,7 +30211,7 @@ export type WarehouseCreate = { __typename?: 'WarehouseCreate'; errors: Array; warehouse?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ warehouseErrors: Array; }; @@ -31542,29 +30220,20 @@ export type WarehouseCreateInput = { address: AddressInput; /** The email address of the warehouse. */ email?: InputMaybe; - /** - * External ID of the warehouse. - * - * Added in Saleor 3.10. - */ + /** External ID of the warehouse. */ externalReference?: InputMaybe; /** Warehouse name. */ name: Scalars['String']['input']; /** * Shipping zones supported by the warehouse. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Providing the zone ids will raise a ValidationError. + * @deprecated Providing the zone ids will raise a ValidationError. */ shippingZones?: InputMaybe>; /** Warehouse slug. */ slug?: InputMaybe; }; -/** - * Event sent when new warehouse is created. - * - * Added in Saleor 3.4. - */ +/** Event sent when new warehouse is created. */ export type WarehouseCreated = Event & { __typename?: 'WarehouseCreated'; /** Time of the event. */ @@ -31588,15 +30257,11 @@ export type WarehouseDelete = { __typename?: 'WarehouseDelete'; errors: Array; warehouse?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ warehouseErrors: Array; }; -/** - * Event sent when warehouse is deleted. - * - * Added in Saleor 3.4. - */ +/** Event sent when warehouse is deleted. */ export type WarehouseDeleted = Event & { __typename?: 'WarehouseDeleted'; /** Time of the event. */ @@ -31623,7 +30288,6 @@ export type WarehouseError = { shippingZones?: Maybe>; }; -/** An enumeration. */ export type WarehouseErrorCode = | 'ALREADY_EXISTS' | 'GRAPHQL_ERROR' @@ -31642,11 +30306,7 @@ export type WarehouseFilterInput = { slugs?: InputMaybe>; }; -/** - * Event sent when warehouse metadata is updated. - * - * Added in Saleor 3.8. - */ +/** Event sent when warehouse metadata is updated. */ export type WarehouseMetadataUpdated = Event & { __typename?: 'WarehouseMetadataUpdated'; /** Time of the event. */ @@ -31670,7 +30330,7 @@ export type WarehouseShippingZoneAssign = { __typename?: 'WarehouseShippingZoneAssign'; errors: Array; warehouse?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ warehouseErrors: Array; }; @@ -31683,7 +30343,7 @@ export type WarehouseShippingZoneUnassign = { __typename?: 'WarehouseShippingZoneUnassign'; errors: Array; warehouse?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ warehouseErrors: Array; }; @@ -31707,32 +30367,20 @@ export type WarehouseUpdate = { __typename?: 'WarehouseUpdate'; errors: Array; warehouse?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ warehouseErrors: Array; }; export type WarehouseUpdateInput = { /** Address of the warehouse. */ address?: InputMaybe; - /** - * Click and collect options: local, all or disabled. - * - * Added in Saleor 3.1. - */ + /** Click and collect options: local, all or disabled. */ clickAndCollectOption?: InputMaybe; /** The email address of the warehouse. */ email?: InputMaybe; - /** - * External ID of the warehouse. - * - * Added in Saleor 3.10. - */ + /** External ID of the warehouse. */ externalReference?: InputMaybe; - /** - * Visibility of warehouse stocks. - * - * Added in Saleor 3.1. - */ + /** Visibility of warehouse stocks. */ isPrivate?: InputMaybe; /** Warehouse name. */ name?: InputMaybe; @@ -31740,11 +30388,7 @@ export type WarehouseUpdateInput = { slug?: InputMaybe; }; -/** - * Event sent when warehouse is updated. - * - * Added in Saleor 3.4. - */ +/** Event sent when warehouse is updated. */ export type WarehouseUpdated = Event & { __typename?: 'WarehouseUpdated'; /** Time of the event. */ @@ -31766,19 +30410,15 @@ export type Webhook = Node & { app: App; /** List of asynchronous webhook events. */ asyncEvents: Array; - /** - * Custom headers, which will be added to HTTP request. - * - * Added in Saleor 3.12. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Custom headers, which will be added to HTTP request. */ customHeaders?: Maybe; + /** Conditions under which webhook delivery is deferred. */ + deferIfConditions?: Maybe>; /** Event deliveries. */ eventDeliveries?: Maybe; /** * List of webhook events. - * @deprecated This field will be removed in Saleor 4.0. Use `asyncEvents` or `syncEvents` instead. + * @deprecated Use `asyncEvents` or `syncEvents` instead. */ events: Array; /** The ID of webhook. */ @@ -31789,7 +30429,7 @@ export type Webhook = Node & { name?: Maybe; /** * Used to create a hash signature for each payload. - * @deprecated This field will be removed in Saleor 4.0. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS. + * @deprecated As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS. */ secretKey?: Maybe; /** Used to define payloads for specific events. */ @@ -31820,7 +30460,7 @@ export type WebhookCreate = { __typename?: 'WebhookCreate'; errors: Array; webhook?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ webhookErrors: Array; }; @@ -31829,34 +30469,22 @@ export type WebhookCreateInput = { app?: InputMaybe; /** The asynchronous events that webhook wants to subscribe. */ asyncEvents?: InputMaybe>; - /** - * 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. - * - * Added in Saleor 3.12. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** 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?: InputMaybe; /** * The events that webhook wants to subscribe. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `asyncEvents` or `syncEvents` instead. + * @deprecated Use `asyncEvents` or `syncEvents` instead. */ events?: InputMaybe>; /** Determine if webhook will be set active or not. */ isActive?: InputMaybe; /** The name of the webhook. */ name?: InputMaybe; - /** - * Subscription query used to define a webhook payload. - * - * Added in Saleor 3.2. - */ + /** Subscription query used to define a webhook payload. */ query?: InputMaybe; /** * The secret key used to create a hash signature with each payload. - * - * DEPRECATED: this field will be removed in Saleor 4.0. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS. + * @deprecated As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS. */ secretKey?: InputMaybe; /** The synchronous events that webhook wants to subscribe. */ @@ -31865,8 +30493,12 @@ export type WebhookCreateInput = { targetUrl?: InputMaybe; }; +/** Conditions under which a webhook delivery should be deferred. If any condition evaluates to true, the webhook will not fire. */ +export type WebhookDeferIfConditionEnum = + | 'ADDRESS_MISSING'; + /** - * Delete a webhook. Before the deletion, the webhook is deactivated to pause any deliveries that are already scheduled. The deletion might fail if delivery is in progress. In such a case, the webhook is not deleted but remains deactivated. + * 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. * * Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP. */ @@ -31874,17 +30506,13 @@ export type WebhookDelete = { __typename?: 'WebhookDelete'; errors: Array; webhook?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ webhookErrors: Array; }; /** * Performs a dry run of a webhook event. Supports a single event (the first, if multiple provided in the `query`). Requires permission relevant to processed event. * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER. */ export type WebhookDryRun = { @@ -31904,7 +30532,6 @@ export type WebhookDryRunError = { message?: Maybe; }; -/** An enumeration. */ export type WebhookDryRunErrorCode = | 'GRAPHQL_ERROR' | 'INVALID_ID' @@ -31926,7 +30553,6 @@ export type WebhookError = { message?: Maybe; }; -/** An enumeration. */ export type WebhookErrorCode = | 'DELETE_FAILED' | 'GRAPHQL_ERROR' @@ -31990,11 +30616,7 @@ export type WebhookEventTypeAsyncEnum = | 'ADDRESS_DELETED' /** An address updated. */ | 'ADDRESS_UPDATED' - /** - * All the events. - * - * DEPRECATED: this value will be removed in Saleor 4.0. - */ + /** All the events. */ | 'ANY_EVENTS' /** An app deleted. */ | 'APP_DELETED' @@ -32034,12 +30656,19 @@ export type WebhookEventTypeAsyncEnum = | 'CHANNEL_UPDATED' /** A new checkout is created. */ | 'CHECKOUT_CREATED' - | 'CHECKOUT_FULLY_PAID' /** - * A checkout metadata is updated. + * A checkout was fully authorized (its `authorizeStatus` is `FULL`). + * + * This event is emitted only for checkouts whose payments are processed through the Transaction API. + */ + | 'CHECKOUT_FULLY_AUTHORIZED' + /** + * A checkout was fully paid (its `chargeStatus` is `FULL` or `OVERCHARGED`). This event is not sent if payments are only authorized but not fully charged. * - * Added in Saleor 3.8. + * This event is emitted only for checkouts whose payments are processed through the Transaction API. */ + | 'CHECKOUT_FULLY_PAID' + /** A checkout metadata is updated. */ | 'CHECKOUT_METADATA_UPDATED' /** A checkout is updated. It also triggers all updates related to the checkout. */ | 'CHECKOUT_UPDATED' @@ -32047,11 +30676,7 @@ export type WebhookEventTypeAsyncEnum = | 'COLLECTION_CREATED' /** A collection is deleted. */ | 'COLLECTION_DELETED' - /** - * A collection metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A collection metadata is updated. */ | 'COLLECTION_METADATA_UPDATED' /** A collection is updated. */ | 'COLLECTION_UPDATED' @@ -32059,11 +30684,7 @@ export type WebhookEventTypeAsyncEnum = | 'CUSTOMER_CREATED' /** A customer account is deleted. */ | 'CUSTOMER_DELETED' - /** - * A customer account metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A customer account metadata is updated. */ | 'CUSTOMER_METADATA_UPDATED' /** A customer account is updated. */ | 'CUSTOMER_UPDATED' @@ -32079,36 +30700,18 @@ export type WebhookEventTypeAsyncEnum = | 'FULFILLMENT_CANCELED' /** A new fulfillment is created. */ | 'FULFILLMENT_CREATED' - /** - * A fulfillment metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A fulfillment metadata is updated. */ | 'FULFILLMENT_METADATA_UPDATED' | 'FULFILLMENT_TRACKING_NUMBER_UPDATED' /** A new gift card created. */ | 'GIFT_CARD_CREATED' /** A gift card is deleted. */ | 'GIFT_CARD_DELETED' - /** - * A gift card export is completed. - * - * Added in Saleor 3.16. - */ + /** A gift card export is completed. */ | 'GIFT_CARD_EXPORT_COMPLETED' - /** - * A gift card metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A gift card metadata is updated. */ | 'GIFT_CARD_METADATA_UPDATED' - /** - * A gift card has been sent. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** A gift card has been sent. */ | 'GIFT_CARD_SENT' /** A gift card status is changed. */ | 'GIFT_CARD_STATUS_CHANGED' @@ -32132,21 +30735,11 @@ export type WebhookEventTypeAsyncEnum = | 'MENU_ITEM_UPDATED' /** A menu is updated. */ | 'MENU_UPDATED' - /** - * User notification triggered. - * - * DEPRECATED: this value will be removed in Saleor 4.0. See the docs for more details about migrating from NOTIFY_USER to other events: https://docs.saleor.io/docs/next/upgrade-guides/notify-user-deprecation - */ + /** User notification triggered. */ | 'NOTIFY_USER' /** An observability event is created. */ | 'OBSERVABILITY' - /** - * Orders are imported. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Orders are imported. */ | 'ORDER_BULK_CREATED' /** An order is cancelled. */ | 'ORDER_CANCELLED' @@ -32160,35 +30753,13 @@ export type WebhookEventTypeAsyncEnum = | 'ORDER_FULFILLED' /** Payment is made and an order is fully paid. */ | 'ORDER_FULLY_PAID' - /** - * The order is fully refunded. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The order is fully refunded. */ | 'ORDER_FULLY_REFUNDED' - /** - * An order metadata is updated. - * - * Added in Saleor 3.8. - */ + /** An order metadata is updated. */ | 'ORDER_METADATA_UPDATED' - /** - * Payment has been made. The order may be partially or fully paid. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Payment has been made. The order may be partially or fully paid. */ | 'ORDER_PAID' - /** - * The order received a refund. The order may be partially or fully refunded. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The order received a refund. The order may be partially or fully refunded. */ | 'ORDER_REFUNDED' /** An order is updated; triggered for all changes related to an order; covers all other order webhooks, except for ORDER_CREATED. */ | 'ORDER_UPDATED' @@ -32214,35 +30785,15 @@ export type WebhookEventTypeAsyncEnum = | 'PRODUCT_CREATED' /** A product is deleted. */ | 'PRODUCT_DELETED' - /** - * A product export is completed. - * - * Added in Saleor 3.16. - */ + /** A product export is completed. */ | 'PRODUCT_EXPORT_COMPLETED' - /** - * A new product media is created. - * - * Added in Saleor 3.12. - */ + /** A new product media is created. */ | 'PRODUCT_MEDIA_CREATED' - /** - * A product media is deleted. - * - * Added in Saleor 3.12. - */ + /** A product media is deleted. */ | 'PRODUCT_MEDIA_DELETED' - /** - * A product media is updated. - * - * Added in Saleor 3.12. - */ + /** A product media is updated. */ | 'PRODUCT_MEDIA_UPDATED' - /** - * A product metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A product metadata is updated. */ | 'PRODUCT_METADATA_UPDATED' /** A product is updated. */ | 'PRODUCT_UPDATED' @@ -32252,11 +30803,7 @@ export type WebhookEventTypeAsyncEnum = | 'PRODUCT_VARIANT_CREATED' /** A product variant is deleted. Warning: this event will not be executed when parent product has been deleted. Check PRODUCT_DELETED. */ | 'PRODUCT_VARIANT_DELETED' - /** - * A product variant metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A product variant metadata is updated. */ | 'PRODUCT_VARIANT_METADATA_UPDATED' /** A product variant is out of stock. */ | 'PRODUCT_VARIANT_OUT_OF_STOCK' @@ -32298,19 +30845,11 @@ export type WebhookEventTypeAsyncEnum = | 'SHIPPING_ZONE_CREATED' /** A shipping zone is deleted. */ | 'SHIPPING_ZONE_DELETED' - /** - * A shipping zone metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A shipping zone metadata is updated. */ | 'SHIPPING_ZONE_METADATA_UPDATED' /** A shipping zone is updated. */ | 'SHIPPING_ZONE_UPDATED' - /** - * Shop metadata is updated. - * - * Added in Saleor 3.15. - */ + /** Shop metadata is updated. */ | 'SHOP_METADATA_UPDATED' /** A new staff user is created. */ | 'STAFF_CREATED' @@ -32320,17 +30859,9 @@ export type WebhookEventTypeAsyncEnum = | 'STAFF_SET_PASSWORD_REQUESTED' /** A staff user is updated. */ | 'STAFF_UPDATED' - /** - * A thumbnail is created. - * - * Added in Saleor 3.12. - */ + /** A thumbnail is created. */ | 'THUMBNAIL_CREATED' - /** - * Transaction item metadata is updated. - * - * Added in Saleor 3.8. - */ + /** Transaction item metadata is updated. */ | 'TRANSACTION_ITEM_METADATA_UPDATED' /** A new translation is created. */ | 'TRANSLATION_CREATED' @@ -32348,11 +30879,7 @@ export type WebhookEventTypeAsyncEnum = | 'VOUCHER_CREATED' /** A voucher is deleted. */ | 'VOUCHER_DELETED' - /** - * A voucher metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A voucher metadata is updated. */ | 'VOUCHER_METADATA_UPDATED' /** A voucher is updated. */ | 'VOUCHER_UPDATED' @@ -32360,11 +30887,7 @@ export type WebhookEventTypeAsyncEnum = | 'WAREHOUSE_CREATED' /** A warehouse is deleted. */ | 'WAREHOUSE_DELETED' - /** - * A warehouse metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A warehouse metadata is updated. */ | 'WAREHOUSE_METADATA_UPDATED' /** A warehouse is updated. */ | 'WAREHOUSE_UPDATED'; @@ -32391,11 +30914,7 @@ export type WebhookEventTypeEnum = | 'ADDRESS_DELETED' /** An address updated. */ | 'ADDRESS_UPDATED' - /** - * All the events. - * - * DEPRECATED: this value will be removed in Saleor 4.0. - */ + /** All the events. */ | 'ANY_EVENTS' /** An app deleted. */ | 'APP_DELETED' @@ -32433,22 +30952,25 @@ export type WebhookEventTypeEnum = | 'CHANNEL_STATUS_CHANGED' /** A channel is updated. */ | 'CHANNEL_UPDATED' - /** - * Event called for checkout tax calculation. - * - * Added in Saleor 3.6. - */ + /** Event called for checkout tax calculation. */ | 'CHECKOUT_CALCULATE_TAXES' /** A new checkout is created. */ | 'CHECKOUT_CREATED' /** Filter shipping methods for checkout. */ | 'CHECKOUT_FILTER_SHIPPING_METHODS' - | 'CHECKOUT_FULLY_PAID' /** - * A checkout metadata is updated. + * A checkout was fully authorized (its `authorizeStatus` is `FULL`). + * + * This event is emitted only for checkouts whose payments are processed through the Transaction API. + */ + | 'CHECKOUT_FULLY_AUTHORIZED' + /** + * A checkout was fully paid (its `chargeStatus` is `FULL` or `OVERCHARGED`). This event is not sent if payments are only authorized but not fully charged. * - * Added in Saleor 3.8. + * This event is emitted only for checkouts whose payments are processed through the Transaction API. */ + | 'CHECKOUT_FULLY_PAID' + /** A checkout metadata is updated. */ | 'CHECKOUT_METADATA_UPDATED' /** A checkout is updated. It also triggers all updates related to the checkout. */ | 'CHECKOUT_UPDATED' @@ -32456,11 +30978,7 @@ export type WebhookEventTypeEnum = | 'COLLECTION_CREATED' /** A collection is deleted. */ | 'COLLECTION_DELETED' - /** - * A collection metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A collection metadata is updated. */ | 'COLLECTION_METADATA_UPDATED' /** A collection is updated. */ | 'COLLECTION_UPDATED' @@ -32468,11 +30986,7 @@ export type WebhookEventTypeEnum = | 'CUSTOMER_CREATED' /** A customer account is deleted. */ | 'CUSTOMER_DELETED' - /** - * A customer account metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A customer account metadata is updated. */ | 'CUSTOMER_METADATA_UPDATED' /** A customer account is updated. */ | 'CUSTOMER_UPDATED' @@ -32488,36 +31002,18 @@ export type WebhookEventTypeEnum = | 'FULFILLMENT_CANCELED' /** A new fulfillment is created. */ | 'FULFILLMENT_CREATED' - /** - * A fulfillment metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A fulfillment metadata is updated. */ | 'FULFILLMENT_METADATA_UPDATED' | 'FULFILLMENT_TRACKING_NUMBER_UPDATED' /** A new gift card created. */ | 'GIFT_CARD_CREATED' /** A gift card is deleted. */ | 'GIFT_CARD_DELETED' - /** - * A gift card export is completed. - * - * Added in Saleor 3.16. - */ + /** A gift card export is completed. */ | 'GIFT_CARD_EXPORT_COMPLETED' - /** - * A gift card metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A gift card metadata is updated. */ | 'GIFT_CARD_METADATA_UPDATED' - /** - * A gift card has been sent. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** A gift card has been sent. */ | 'GIFT_CARD_SENT' /** A gift card status is changed. */ | 'GIFT_CARD_STATUS_CHANGED' @@ -32542,27 +31038,13 @@ export type WebhookEventTypeEnum = | 'MENU_ITEM_UPDATED' /** A menu is updated. */ | 'MENU_UPDATED' - /** - * User notification triggered. - * - * DEPRECATED: this value will be removed in Saleor 4.0. See the docs for more details about migrating from NOTIFY_USER to other events: https://docs.saleor.io/docs/next/upgrade-guides/notify-user-deprecation - */ + /** User notification triggered. */ | 'NOTIFY_USER' /** An observability event is created. */ | 'OBSERVABILITY' - /** - * Orders are imported. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Orders are imported. */ | 'ORDER_BULK_CREATED' - /** - * Event called for order tax calculation. - * - * Added in Saleor 3.6. - */ + /** Event called for order tax calculation. */ | 'ORDER_CALCULATE_TAXES' /** An order is cancelled. */ | 'ORDER_CANCELLED' @@ -32578,35 +31060,13 @@ export type WebhookEventTypeEnum = | 'ORDER_FULFILLED' /** Payment is made and an order is fully paid. */ | 'ORDER_FULLY_PAID' - /** - * The order is fully refunded. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The order is fully refunded. */ | 'ORDER_FULLY_REFUNDED' - /** - * An order metadata is updated. - * - * Added in Saleor 3.8. - */ + /** An order metadata is updated. */ | 'ORDER_METADATA_UPDATED' - /** - * Payment has been made. The order may be partially or fully paid. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Payment has been made. The order may be partially or fully paid. */ | 'ORDER_PAID' - /** - * The order received a refund. The order may be partially or fully refunded. - * - * Added in Saleor 3.14. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** The order received a refund. The order may be partially or fully refunded. */ | 'ORDER_REFUNDED' /** An order is updated; triggered for all changes related to an order; covers all other order webhooks, except for ORDER_CREATED. */ | 'ORDER_UPDATED' @@ -32650,35 +31110,15 @@ export type WebhookEventTypeEnum = | 'PRODUCT_CREATED' /** A product is deleted. */ | 'PRODUCT_DELETED' - /** - * A product export is completed. - * - * Added in Saleor 3.16. - */ + /** A product export is completed. */ | 'PRODUCT_EXPORT_COMPLETED' - /** - * A new product media is created. - * - * Added in Saleor 3.12. - */ + /** A new product media is created. */ | 'PRODUCT_MEDIA_CREATED' - /** - * A product media is deleted. - * - * Added in Saleor 3.12. - */ + /** A product media is deleted. */ | 'PRODUCT_MEDIA_DELETED' - /** - * A product media is updated. - * - * Added in Saleor 3.12. - */ + /** A product media is updated. */ | 'PRODUCT_MEDIA_UPDATED' - /** - * A product metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A product metadata is updated. */ | 'PRODUCT_METADATA_UPDATED' /** A product is updated. */ | 'PRODUCT_UPDATED' @@ -32688,11 +31128,7 @@ export type WebhookEventTypeEnum = | 'PRODUCT_VARIANT_CREATED' /** A product variant is deleted. Warning: this event will not be executed when parent product has been deleted. Check PRODUCT_DELETED. */ | 'PRODUCT_VARIANT_DELETED' - /** - * A product variant metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A product variant metadata is updated. */ | 'PRODUCT_VARIANT_METADATA_UPDATED' /** A product variant is out of stock. */ | 'PRODUCT_VARIANT_OUT_OF_STOCK' @@ -32736,19 +31172,11 @@ export type WebhookEventTypeEnum = | 'SHIPPING_ZONE_CREATED' /** A shipping zone is deleted. */ | 'SHIPPING_ZONE_DELETED' - /** - * A shipping zone metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A shipping zone metadata is updated. */ | 'SHIPPING_ZONE_METADATA_UPDATED' /** A shipping zone is updated. */ | 'SHIPPING_ZONE_UPDATED' - /** - * Shop metadata is updated. - * - * Added in Saleor 3.15. - */ + /** Shop metadata is updated. */ | 'SHOP_METADATA_UPDATED' /** A new staff user is created. */ | 'STAFF_CREATED' @@ -32759,43 +31187,17 @@ export type WebhookEventTypeEnum = /** A staff user is updated. */ | 'STAFF_UPDATED' | 'STORED_PAYMENT_METHOD_DELETE_REQUESTED' - /** - * A thumbnail is created. - * - * Added in Saleor 3.12. - */ + /** A thumbnail is created. */ | 'THUMBNAIL_CREATED' - /** - * Event called when cancel has been requested for transaction. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Event called when cancel has been requested for transaction. */ | 'TRANSACTION_CANCELATION_REQUESTED' - /** - * Event called when charge has been requested for transaction. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Event called when charge has been requested for transaction. */ | 'TRANSACTION_CHARGE_REQUESTED' - | 'TRANSACTION_INITIALIZE_SESSION' - /** - * Transaction item metadata is updated. - * - * Added in Saleor 3.8. - */ + | 'TRANSACTION_INITIALIZE_SESSION' + /** Transaction item metadata is updated. */ | 'TRANSACTION_ITEM_METADATA_UPDATED' | 'TRANSACTION_PROCESS_SESSION' - /** - * Event called when refund has been requested for transaction. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Event called when refund has been requested for transaction. */ | 'TRANSACTION_REFUND_REQUESTED' /** A new translation is created. */ | 'TRANSLATION_CREATED' @@ -32813,11 +31215,7 @@ export type WebhookEventTypeEnum = | 'VOUCHER_CREATED' /** A voucher is deleted. */ | 'VOUCHER_DELETED' - /** - * A voucher metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A voucher metadata is updated. */ | 'VOUCHER_METADATA_UPDATED' /** A voucher is updated. */ | 'VOUCHER_UPDATED' @@ -32825,31 +31223,19 @@ export type WebhookEventTypeEnum = | 'WAREHOUSE_CREATED' /** A warehouse is deleted. */ | 'WAREHOUSE_DELETED' - /** - * A warehouse metadata is updated. - * - * Added in Saleor 3.8. - */ + /** A warehouse metadata is updated. */ | 'WAREHOUSE_METADATA_UPDATED' /** A warehouse is updated. */ | 'WAREHOUSE_UPDATED'; /** Enum determining type of webhook. */ export type WebhookEventTypeSyncEnum = - /** - * Event called for checkout tax calculation. - * - * Added in Saleor 3.6. - */ + /** Event called for checkout tax calculation. */ | 'CHECKOUT_CALCULATE_TAXES' /** Filter shipping methods for checkout. */ | 'CHECKOUT_FILTER_SHIPPING_METHODS' | 'LIST_STORED_PAYMENT_METHODS' - /** - * Event called for order tax calculation. - * - * Added in Saleor 3.6. - */ + /** Event called for order tax calculation. */ | 'ORDER_CALCULATE_TAXES' /** Filter shipping methods for order. */ | 'ORDER_FILTER_SHIPPING_METHODS' @@ -32874,34 +31260,15 @@ export type WebhookEventTypeSyncEnum = /** Fetch external shipping methods for checkout. */ | 'SHIPPING_LIST_METHODS_FOR_CHECKOUT' | 'STORED_PAYMENT_METHOD_DELETE_REQUESTED' - /** - * Event called when cancel has been requested for transaction. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Event called when cancel has been requested for transaction. */ | 'TRANSACTION_CANCELATION_REQUESTED' - /** - * Event called when charge has been requested for transaction. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Event called when charge has been requested for transaction. */ | 'TRANSACTION_CHARGE_REQUESTED' | 'TRANSACTION_INITIALIZE_SESSION' | 'TRANSACTION_PROCESS_SESSION' - /** - * Event called when refund has been requested for transaction. - * - * Added in Saleor 3.13. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** Event called when refund has been requested for transaction. */ | 'TRANSACTION_REFUND_REQUESTED'; -/** An enumeration. */ export type WebhookSampleEventTypeEnum = | 'ACCOUNT_CHANGE_EMAIL_REQUESTED' | 'ACCOUNT_CONFIRMATION_REQUESTED' @@ -32932,6 +31299,7 @@ export type WebhookSampleEventTypeEnum = | 'CHANNEL_STATUS_CHANGED' | 'CHANNEL_UPDATED' | 'CHECKOUT_CREATED' + | 'CHECKOUT_FULLY_AUTHORIZED' | 'CHECKOUT_FULLY_PAID' | 'CHECKOUT_METADATA_UPDATED' | 'CHECKOUT_UPDATED' @@ -33048,10 +31416,6 @@ export type WebhookSampleEventTypeEnum = /** * Trigger a webhook event. Supports a single event (the first, if multiple provided in the `webhook.subscription_query`). Requires permission relevant to processed event. Successfully delivered webhook returns `delivery` with status='PENDING' and empty payload. * - * Added in Saleor 3.11. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - * * Requires one of the following permissions: AUTHENTICATED_STAFF_USER. */ export type WebhookTrigger = { @@ -33070,7 +31434,6 @@ export type WebhookTriggerError = { message?: Maybe; }; -/** An enumeration. */ export type WebhookTriggerErrorCode = | 'GRAPHQL_ERROR' | 'INVALID_ID' @@ -33092,7 +31455,7 @@ export type WebhookUpdate = { __typename?: 'WebhookUpdate'; errors: Array; webhook?: Maybe; - /** @deprecated This field will be removed in Saleor 4.0. Use `errors` field instead. */ + /** @deprecated Use `errors` field instead. */ webhookErrors: Array; }; @@ -33101,34 +31464,22 @@ export type WebhookUpdateInput = { app?: InputMaybe; /** The asynchronous events that webhook wants to subscribe. */ asyncEvents?: InputMaybe>; - /** - * 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. - * - * Added in Saleor 3.12. - * - * Note: this API is currently in Feature Preview and can be subject to changes at later point. - */ + /** 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?: InputMaybe; /** * The events that webhook wants to subscribe. - * - * DEPRECATED: this field will be removed in Saleor 4.0. Use `asyncEvents` or `syncEvents` instead. + * @deprecated Use `asyncEvents` or `syncEvents` instead. */ events?: InputMaybe>; /** Determine if webhook will be set active or not. */ isActive?: InputMaybe; /** The new name of the webhook. */ name?: InputMaybe; - /** - * Subscription query used to define a webhook payload. - * - * Added in Saleor 3.2. - */ + /** Subscription query used to define a webhook payload. */ query?: InputMaybe; /** * Use to create a hash signature with each payload. - * - * DEPRECATED: this field will be removed in Saleor 4.0. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS. + * @deprecated As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS. */ secretKey?: InputMaybe; /** The synchronous events that webhook wants to subscribe. */ @@ -33146,7 +31497,6 @@ export type Weight = { value: Scalars['Float']['output']; }; -/** An enumeration. */ export type WeightUnitsEnum = | 'G' | 'KG' @@ -33154,6 +31504,16 @@ export type WeightUnitsEnum = | 'OZ' | 'TONNE'; +/** Represents the WIDGET target options for an app extension. */ +export type WidgetTargetOptions = { + __typename?: 'WidgetTargetOptions'; + /** + * HTTP method for Widget target (GET or POST) + * @deprecated Use `settings` field directly. + */ + method: HttpMethod; +}; + /** _Entity union as defined by Federation spec. */ export type _Entity = Address | App | Category | Collection | Group | Order | PageType | Product | ProductMedia | ProductType | ProductVariant | User; @@ -33165,327 +31525,7 @@ export type _Service = { export type AddressFragment = { __typename?: 'Address', streetAddress1: string, streetAddress2: string, city: string, countryArea: string, postalCode: string, country: { __typename?: 'CountryDisplay', code: string } }; -type CalculateTaxesEvent_AccountChangeEmailRequested_Fragment = { __typename: 'AccountChangeEmailRequested', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AccountConfirmationRequested_Fragment = { __typename: 'AccountConfirmationRequested', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AccountConfirmed_Fragment = { __typename: 'AccountConfirmed', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AccountDeleteRequested_Fragment = { __typename: 'AccountDeleteRequested', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AccountDeleted_Fragment = { __typename: 'AccountDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AccountEmailChanged_Fragment = { __typename: 'AccountEmailChanged', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AccountSetPasswordRequested_Fragment = { __typename: 'AccountSetPasswordRequested', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AddressCreated_Fragment = { __typename: 'AddressCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AddressDeleted_Fragment = { __typename: 'AddressDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AddressUpdated_Fragment = { __typename: 'AddressUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AppDeleted_Fragment = { __typename: 'AppDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AppInstalled_Fragment = { __typename: 'AppInstalled', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AppStatusChanged_Fragment = { __typename: 'AppStatusChanged', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AppUpdated_Fragment = { __typename: 'AppUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AttributeCreated_Fragment = { __typename: 'AttributeCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AttributeDeleted_Fragment = { __typename: 'AttributeDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AttributeUpdated_Fragment = { __typename: 'AttributeUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AttributeValueCreated_Fragment = { __typename: 'AttributeValueCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AttributeValueDeleted_Fragment = { __typename: 'AttributeValueDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_AttributeValueUpdated_Fragment = { __typename: 'AttributeValueUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_CalculateTaxes_Fragment = { __typename: 'CalculateTaxes', issuedAt?: string | null, version?: string | null, taxBase: { __typename?: 'TaxableObject', pricesEnteredWithTax: boolean, currency: string, channel: { __typename?: 'Channel', slug: string, id: string }, discounts: Array<{ __typename?: 'TaxableObjectDiscount', type: TaxableObjectDiscountTypeEnum, amount: { __typename?: 'Money', amount: number } }>, address?: { __typename?: 'Address', streetAddress1: string, streetAddress2: string, city: string, countryArea: string, postalCode: string, country: { __typename?: 'CountryDisplay', code: string } } | null, shippingPrice: { __typename?: 'Money', amount: number }, lines: Array<{ __typename?: 'TaxableObjectLine', quantity: number, sourceLine: { __typename: 'CheckoutLine', id: string, checkoutProductVariant: { __typename?: 'ProductVariant', id: string, sku?: string | null, product: { __typename?: 'Product', taxClass?: { __typename?: 'TaxClass', id: string, name: string } | null } } } | { __typename: 'OrderLine', id: string, orderProductVariant?: { __typename?: 'ProductVariant', id: string, sku?: string | null, product: { __typename?: 'Product', taxClass?: { __typename?: 'TaxClass', id: string, name: string } | null } } | null }, unitPrice: { __typename?: 'Money', amount: number }, totalPrice: { __typename?: 'Money', amount: number } }>, sourceObject: { __typename: 'Checkout', id: string, avataxEntityCode?: string | null, avataxCustomerCode?: string | null, avataxExemptionStatus?: string | null, avataxShipFromAddress?: string | null, user?: { __typename?: 'User', id: string, email: string, avataxCustomerCode?: string | null } | null } | { __typename: 'Order', id: string, avataxEntityCode?: string | null, avataxCustomerCode?: string | null, avataxExemptionStatus?: string | null, avataxShipFromAddress?: string | null, user?: { __typename?: 'User', id: string, email: string, avataxCustomerCode?: string | null } | null } }, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null }; - -type CalculateTaxesEvent_CategoryCreated_Fragment = { __typename: 'CategoryCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_CategoryDeleted_Fragment = { __typename: 'CategoryDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_CategoryUpdated_Fragment = { __typename: 'CategoryUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ChannelCreated_Fragment = { __typename: 'ChannelCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ChannelDeleted_Fragment = { __typename: 'ChannelDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ChannelMetadataUpdated_Fragment = { __typename: 'ChannelMetadataUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ChannelStatusChanged_Fragment = { __typename: 'ChannelStatusChanged', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ChannelUpdated_Fragment = { __typename: 'ChannelUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_CheckoutCreated_Fragment = { __typename: 'CheckoutCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_CheckoutFilterShippingMethods_Fragment = { __typename: 'CheckoutFilterShippingMethods', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_CheckoutFullyPaid_Fragment = { __typename: 'CheckoutFullyPaid', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_CheckoutMetadataUpdated_Fragment = { __typename: 'CheckoutMetadataUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_CheckoutUpdated_Fragment = { __typename: 'CheckoutUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_CollectionCreated_Fragment = { __typename: 'CollectionCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_CollectionDeleted_Fragment = { __typename: 'CollectionDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_CollectionMetadataUpdated_Fragment = { __typename: 'CollectionMetadataUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_CollectionUpdated_Fragment = { __typename: 'CollectionUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_CustomerCreated_Fragment = { __typename: 'CustomerCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_CustomerMetadataUpdated_Fragment = { __typename: 'CustomerMetadataUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_CustomerUpdated_Fragment = { __typename: 'CustomerUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_DraftOrderCreated_Fragment = { __typename: 'DraftOrderCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_DraftOrderDeleted_Fragment = { __typename: 'DraftOrderDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_DraftOrderUpdated_Fragment = { __typename: 'DraftOrderUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_FulfillmentApproved_Fragment = { __typename: 'FulfillmentApproved', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_FulfillmentCanceled_Fragment = { __typename: 'FulfillmentCanceled', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_FulfillmentCreated_Fragment = { __typename: 'FulfillmentCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_FulfillmentMetadataUpdated_Fragment = { __typename: 'FulfillmentMetadataUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_FulfillmentTrackingNumberUpdated_Fragment = { __typename: 'FulfillmentTrackingNumberUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_GiftCardCreated_Fragment = { __typename: 'GiftCardCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_GiftCardDeleted_Fragment = { __typename: 'GiftCardDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_GiftCardExportCompleted_Fragment = { __typename: 'GiftCardExportCompleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_GiftCardMetadataUpdated_Fragment = { __typename: 'GiftCardMetadataUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_GiftCardSent_Fragment = { __typename: 'GiftCardSent', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_GiftCardStatusChanged_Fragment = { __typename: 'GiftCardStatusChanged', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_GiftCardUpdated_Fragment = { __typename: 'GiftCardUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_InvoiceDeleted_Fragment = { __typename: 'InvoiceDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_InvoiceRequested_Fragment = { __typename: 'InvoiceRequested', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_InvoiceSent_Fragment = { __typename: 'InvoiceSent', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ListStoredPaymentMethods_Fragment = { __typename: 'ListStoredPaymentMethods', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_MenuCreated_Fragment = { __typename: 'MenuCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_MenuDeleted_Fragment = { __typename: 'MenuDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_MenuItemCreated_Fragment = { __typename: 'MenuItemCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_MenuItemDeleted_Fragment = { __typename: 'MenuItemDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_MenuItemUpdated_Fragment = { __typename: 'MenuItemUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_MenuUpdated_Fragment = { __typename: 'MenuUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_OrderBulkCreated_Fragment = { __typename: 'OrderBulkCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_OrderCancelled_Fragment = { __typename: 'OrderCancelled', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_OrderConfirmed_Fragment = { __typename: 'OrderConfirmed', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_OrderCreated_Fragment = { __typename: 'OrderCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_OrderExpired_Fragment = { __typename: 'OrderExpired', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_OrderFilterShippingMethods_Fragment = { __typename: 'OrderFilterShippingMethods', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_OrderFulfilled_Fragment = { __typename: 'OrderFulfilled', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_OrderFullyPaid_Fragment = { __typename: 'OrderFullyPaid', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_OrderFullyRefunded_Fragment = { __typename: 'OrderFullyRefunded', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_OrderMetadataUpdated_Fragment = { __typename: 'OrderMetadataUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_OrderPaid_Fragment = { __typename: 'OrderPaid', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_OrderRefunded_Fragment = { __typename: 'OrderRefunded', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_OrderUpdated_Fragment = { __typename: 'OrderUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PageCreated_Fragment = { __typename: 'PageCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PageDeleted_Fragment = { __typename: 'PageDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PageTypeCreated_Fragment = { __typename: 'PageTypeCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PageTypeDeleted_Fragment = { __typename: 'PageTypeDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PageTypeUpdated_Fragment = { __typename: 'PageTypeUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PageUpdated_Fragment = { __typename: 'PageUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PaymentAuthorize_Fragment = { __typename: 'PaymentAuthorize', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PaymentCaptureEvent_Fragment = { __typename: 'PaymentCaptureEvent', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PaymentConfirmEvent_Fragment = { __typename: 'PaymentConfirmEvent', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PaymentGatewayInitializeSession_Fragment = { __typename: 'PaymentGatewayInitializeSession', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PaymentGatewayInitializeTokenizationSession_Fragment = { __typename: 'PaymentGatewayInitializeTokenizationSession', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PaymentListGateways_Fragment = { __typename: 'PaymentListGateways', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PaymentMethodInitializeTokenizationSession_Fragment = { __typename: 'PaymentMethodInitializeTokenizationSession', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PaymentMethodProcessTokenizationSession_Fragment = { __typename: 'PaymentMethodProcessTokenizationSession', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PaymentProcessEvent_Fragment = { __typename: 'PaymentProcessEvent', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PaymentRefundEvent_Fragment = { __typename: 'PaymentRefundEvent', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PaymentVoidEvent_Fragment = { __typename: 'PaymentVoidEvent', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PermissionGroupCreated_Fragment = { __typename: 'PermissionGroupCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PermissionGroupDeleted_Fragment = { __typename: 'PermissionGroupDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PermissionGroupUpdated_Fragment = { __typename: 'PermissionGroupUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ProductCreated_Fragment = { __typename: 'ProductCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ProductDeleted_Fragment = { __typename: 'ProductDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ProductExportCompleted_Fragment = { __typename: 'ProductExportCompleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ProductMediaCreated_Fragment = { __typename: 'ProductMediaCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ProductMediaDeleted_Fragment = { __typename: 'ProductMediaDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ProductMediaUpdated_Fragment = { __typename: 'ProductMediaUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ProductMetadataUpdated_Fragment = { __typename: 'ProductMetadataUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ProductUpdated_Fragment = { __typename: 'ProductUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ProductVariantBackInStock_Fragment = { __typename: 'ProductVariantBackInStock', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ProductVariantCreated_Fragment = { __typename: 'ProductVariantCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ProductVariantDeleted_Fragment = { __typename: 'ProductVariantDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ProductVariantMetadataUpdated_Fragment = { __typename: 'ProductVariantMetadataUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ProductVariantOutOfStock_Fragment = { __typename: 'ProductVariantOutOfStock', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ProductVariantStockUpdated_Fragment = { __typename: 'ProductVariantStockUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ProductVariantUpdated_Fragment = { __typename: 'ProductVariantUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PromotionCreated_Fragment = { __typename: 'PromotionCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PromotionDeleted_Fragment = { __typename: 'PromotionDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PromotionEnded_Fragment = { __typename: 'PromotionEnded', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PromotionRuleCreated_Fragment = { __typename: 'PromotionRuleCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PromotionRuleDeleted_Fragment = { __typename: 'PromotionRuleDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PromotionRuleUpdated_Fragment = { __typename: 'PromotionRuleUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PromotionStarted_Fragment = { __typename: 'PromotionStarted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_PromotionUpdated_Fragment = { __typename: 'PromotionUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_SaleCreated_Fragment = { __typename: 'SaleCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_SaleDeleted_Fragment = { __typename: 'SaleDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_SaleToggle_Fragment = { __typename: 'SaleToggle', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_SaleUpdated_Fragment = { __typename: 'SaleUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ShippingListMethodsForCheckout_Fragment = { __typename: 'ShippingListMethodsForCheckout', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ShippingPriceCreated_Fragment = { __typename: 'ShippingPriceCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ShippingPriceDeleted_Fragment = { __typename: 'ShippingPriceDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ShippingPriceUpdated_Fragment = { __typename: 'ShippingPriceUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ShippingZoneCreated_Fragment = { __typename: 'ShippingZoneCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ShippingZoneDeleted_Fragment = { __typename: 'ShippingZoneDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ShippingZoneMetadataUpdated_Fragment = { __typename: 'ShippingZoneMetadataUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ShippingZoneUpdated_Fragment = { __typename: 'ShippingZoneUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ShopMetadataUpdated_Fragment = { __typename: 'ShopMetadataUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_StaffCreated_Fragment = { __typename: 'StaffCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_StaffDeleted_Fragment = { __typename: 'StaffDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_StaffSetPasswordRequested_Fragment = { __typename: 'StaffSetPasswordRequested', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_StaffUpdated_Fragment = { __typename: 'StaffUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_StoredPaymentMethodDeleteRequested_Fragment = { __typename: 'StoredPaymentMethodDeleteRequested', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_ThumbnailCreated_Fragment = { __typename: 'ThumbnailCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_TransactionCancelationRequested_Fragment = { __typename: 'TransactionCancelationRequested', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_TransactionChargeRequested_Fragment = { __typename: 'TransactionChargeRequested', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_TransactionInitializeSession_Fragment = { __typename: 'TransactionInitializeSession', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_TransactionItemMetadataUpdated_Fragment = { __typename: 'TransactionItemMetadataUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_TransactionProcessSession_Fragment = { __typename: 'TransactionProcessSession', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_TransactionRefundRequested_Fragment = { __typename: 'TransactionRefundRequested', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_TranslationCreated_Fragment = { __typename: 'TranslationCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_TranslationUpdated_Fragment = { __typename: 'TranslationUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_VoucherCodeExportCompleted_Fragment = { __typename: 'VoucherCodeExportCompleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_VoucherCodesCreated_Fragment = { __typename: 'VoucherCodesCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_VoucherCodesDeleted_Fragment = { __typename: 'VoucherCodesDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_VoucherCreated_Fragment = { __typename: 'VoucherCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_VoucherDeleted_Fragment = { __typename: 'VoucherDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_VoucherMetadataUpdated_Fragment = { __typename: 'VoucherMetadataUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_VoucherUpdated_Fragment = { __typename: 'VoucherUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_WarehouseCreated_Fragment = { __typename: 'WarehouseCreated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_WarehouseDeleted_Fragment = { __typename: 'WarehouseDeleted', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_WarehouseMetadataUpdated_Fragment = { __typename: 'WarehouseMetadataUpdated', issuedAt?: string | null, version?: string | null }; - -type CalculateTaxesEvent_WarehouseUpdated_Fragment = { __typename: 'WarehouseUpdated', issuedAt?: string | null, version?: string | null }; - -export type CalculateTaxesEventFragment = CalculateTaxesEvent_AccountChangeEmailRequested_Fragment | CalculateTaxesEvent_AccountConfirmationRequested_Fragment | CalculateTaxesEvent_AccountConfirmed_Fragment | CalculateTaxesEvent_AccountDeleteRequested_Fragment | CalculateTaxesEvent_AccountDeleted_Fragment | CalculateTaxesEvent_AccountEmailChanged_Fragment | CalculateTaxesEvent_AccountSetPasswordRequested_Fragment | CalculateTaxesEvent_AddressCreated_Fragment | CalculateTaxesEvent_AddressDeleted_Fragment | CalculateTaxesEvent_AddressUpdated_Fragment | CalculateTaxesEvent_AppDeleted_Fragment | CalculateTaxesEvent_AppInstalled_Fragment | CalculateTaxesEvent_AppStatusChanged_Fragment | CalculateTaxesEvent_AppUpdated_Fragment | CalculateTaxesEvent_AttributeCreated_Fragment | CalculateTaxesEvent_AttributeDeleted_Fragment | CalculateTaxesEvent_AttributeUpdated_Fragment | CalculateTaxesEvent_AttributeValueCreated_Fragment | CalculateTaxesEvent_AttributeValueDeleted_Fragment | CalculateTaxesEvent_AttributeValueUpdated_Fragment | CalculateTaxesEvent_CalculateTaxes_Fragment | CalculateTaxesEvent_CategoryCreated_Fragment | CalculateTaxesEvent_CategoryDeleted_Fragment | CalculateTaxesEvent_CategoryUpdated_Fragment | CalculateTaxesEvent_ChannelCreated_Fragment | CalculateTaxesEvent_ChannelDeleted_Fragment | CalculateTaxesEvent_ChannelMetadataUpdated_Fragment | CalculateTaxesEvent_ChannelStatusChanged_Fragment | CalculateTaxesEvent_ChannelUpdated_Fragment | CalculateTaxesEvent_CheckoutCreated_Fragment | CalculateTaxesEvent_CheckoutFilterShippingMethods_Fragment | CalculateTaxesEvent_CheckoutFullyPaid_Fragment | CalculateTaxesEvent_CheckoutMetadataUpdated_Fragment | CalculateTaxesEvent_CheckoutUpdated_Fragment | CalculateTaxesEvent_CollectionCreated_Fragment | CalculateTaxesEvent_CollectionDeleted_Fragment | CalculateTaxesEvent_CollectionMetadataUpdated_Fragment | CalculateTaxesEvent_CollectionUpdated_Fragment | CalculateTaxesEvent_CustomerCreated_Fragment | CalculateTaxesEvent_CustomerMetadataUpdated_Fragment | CalculateTaxesEvent_CustomerUpdated_Fragment | CalculateTaxesEvent_DraftOrderCreated_Fragment | CalculateTaxesEvent_DraftOrderDeleted_Fragment | CalculateTaxesEvent_DraftOrderUpdated_Fragment | CalculateTaxesEvent_FulfillmentApproved_Fragment | CalculateTaxesEvent_FulfillmentCanceled_Fragment | CalculateTaxesEvent_FulfillmentCreated_Fragment | CalculateTaxesEvent_FulfillmentMetadataUpdated_Fragment | CalculateTaxesEvent_FulfillmentTrackingNumberUpdated_Fragment | CalculateTaxesEvent_GiftCardCreated_Fragment | CalculateTaxesEvent_GiftCardDeleted_Fragment | CalculateTaxesEvent_GiftCardExportCompleted_Fragment | CalculateTaxesEvent_GiftCardMetadataUpdated_Fragment | CalculateTaxesEvent_GiftCardSent_Fragment | CalculateTaxesEvent_GiftCardStatusChanged_Fragment | CalculateTaxesEvent_GiftCardUpdated_Fragment | CalculateTaxesEvent_InvoiceDeleted_Fragment | CalculateTaxesEvent_InvoiceRequested_Fragment | CalculateTaxesEvent_InvoiceSent_Fragment | CalculateTaxesEvent_ListStoredPaymentMethods_Fragment | CalculateTaxesEvent_MenuCreated_Fragment | CalculateTaxesEvent_MenuDeleted_Fragment | CalculateTaxesEvent_MenuItemCreated_Fragment | CalculateTaxesEvent_MenuItemDeleted_Fragment | CalculateTaxesEvent_MenuItemUpdated_Fragment | CalculateTaxesEvent_MenuUpdated_Fragment | CalculateTaxesEvent_OrderBulkCreated_Fragment | CalculateTaxesEvent_OrderCancelled_Fragment | CalculateTaxesEvent_OrderConfirmed_Fragment | CalculateTaxesEvent_OrderCreated_Fragment | CalculateTaxesEvent_OrderExpired_Fragment | CalculateTaxesEvent_OrderFilterShippingMethods_Fragment | CalculateTaxesEvent_OrderFulfilled_Fragment | CalculateTaxesEvent_OrderFullyPaid_Fragment | CalculateTaxesEvent_OrderFullyRefunded_Fragment | CalculateTaxesEvent_OrderMetadataUpdated_Fragment | CalculateTaxesEvent_OrderPaid_Fragment | CalculateTaxesEvent_OrderRefunded_Fragment | CalculateTaxesEvent_OrderUpdated_Fragment | CalculateTaxesEvent_PageCreated_Fragment | CalculateTaxesEvent_PageDeleted_Fragment | CalculateTaxesEvent_PageTypeCreated_Fragment | CalculateTaxesEvent_PageTypeDeleted_Fragment | CalculateTaxesEvent_PageTypeUpdated_Fragment | CalculateTaxesEvent_PageUpdated_Fragment | CalculateTaxesEvent_PaymentAuthorize_Fragment | CalculateTaxesEvent_PaymentCaptureEvent_Fragment | CalculateTaxesEvent_PaymentConfirmEvent_Fragment | CalculateTaxesEvent_PaymentGatewayInitializeSession_Fragment | CalculateTaxesEvent_PaymentGatewayInitializeTokenizationSession_Fragment | CalculateTaxesEvent_PaymentListGateways_Fragment | CalculateTaxesEvent_PaymentMethodInitializeTokenizationSession_Fragment | CalculateTaxesEvent_PaymentMethodProcessTokenizationSession_Fragment | CalculateTaxesEvent_PaymentProcessEvent_Fragment | CalculateTaxesEvent_PaymentRefundEvent_Fragment | CalculateTaxesEvent_PaymentVoidEvent_Fragment | CalculateTaxesEvent_PermissionGroupCreated_Fragment | CalculateTaxesEvent_PermissionGroupDeleted_Fragment | CalculateTaxesEvent_PermissionGroupUpdated_Fragment | CalculateTaxesEvent_ProductCreated_Fragment | CalculateTaxesEvent_ProductDeleted_Fragment | CalculateTaxesEvent_ProductExportCompleted_Fragment | CalculateTaxesEvent_ProductMediaCreated_Fragment | CalculateTaxesEvent_ProductMediaDeleted_Fragment | CalculateTaxesEvent_ProductMediaUpdated_Fragment | CalculateTaxesEvent_ProductMetadataUpdated_Fragment | CalculateTaxesEvent_ProductUpdated_Fragment | CalculateTaxesEvent_ProductVariantBackInStock_Fragment | CalculateTaxesEvent_ProductVariantCreated_Fragment | CalculateTaxesEvent_ProductVariantDeleted_Fragment | CalculateTaxesEvent_ProductVariantMetadataUpdated_Fragment | CalculateTaxesEvent_ProductVariantOutOfStock_Fragment | CalculateTaxesEvent_ProductVariantStockUpdated_Fragment | CalculateTaxesEvent_ProductVariantUpdated_Fragment | CalculateTaxesEvent_PromotionCreated_Fragment | CalculateTaxesEvent_PromotionDeleted_Fragment | CalculateTaxesEvent_PromotionEnded_Fragment | CalculateTaxesEvent_PromotionRuleCreated_Fragment | CalculateTaxesEvent_PromotionRuleDeleted_Fragment | CalculateTaxesEvent_PromotionRuleUpdated_Fragment | CalculateTaxesEvent_PromotionStarted_Fragment | CalculateTaxesEvent_PromotionUpdated_Fragment | CalculateTaxesEvent_SaleCreated_Fragment | CalculateTaxesEvent_SaleDeleted_Fragment | CalculateTaxesEvent_SaleToggle_Fragment | CalculateTaxesEvent_SaleUpdated_Fragment | CalculateTaxesEvent_ShippingListMethodsForCheckout_Fragment | CalculateTaxesEvent_ShippingPriceCreated_Fragment | CalculateTaxesEvent_ShippingPriceDeleted_Fragment | CalculateTaxesEvent_ShippingPriceUpdated_Fragment | CalculateTaxesEvent_ShippingZoneCreated_Fragment | CalculateTaxesEvent_ShippingZoneDeleted_Fragment | CalculateTaxesEvent_ShippingZoneMetadataUpdated_Fragment | CalculateTaxesEvent_ShippingZoneUpdated_Fragment | CalculateTaxesEvent_ShopMetadataUpdated_Fragment | CalculateTaxesEvent_StaffCreated_Fragment | CalculateTaxesEvent_StaffDeleted_Fragment | CalculateTaxesEvent_StaffSetPasswordRequested_Fragment | CalculateTaxesEvent_StaffUpdated_Fragment | CalculateTaxesEvent_StoredPaymentMethodDeleteRequested_Fragment | CalculateTaxesEvent_ThumbnailCreated_Fragment | CalculateTaxesEvent_TransactionCancelationRequested_Fragment | CalculateTaxesEvent_TransactionChargeRequested_Fragment | CalculateTaxesEvent_TransactionInitializeSession_Fragment | CalculateTaxesEvent_TransactionItemMetadataUpdated_Fragment | CalculateTaxesEvent_TransactionProcessSession_Fragment | CalculateTaxesEvent_TransactionRefundRequested_Fragment | CalculateTaxesEvent_TranslationCreated_Fragment | CalculateTaxesEvent_TranslationUpdated_Fragment | CalculateTaxesEvent_VoucherCodeExportCompleted_Fragment | CalculateTaxesEvent_VoucherCodesCreated_Fragment | CalculateTaxesEvent_VoucherCodesDeleted_Fragment | CalculateTaxesEvent_VoucherCreated_Fragment | CalculateTaxesEvent_VoucherDeleted_Fragment | CalculateTaxesEvent_VoucherMetadataUpdated_Fragment | CalculateTaxesEvent_VoucherUpdated_Fragment | CalculateTaxesEvent_WarehouseCreated_Fragment | CalculateTaxesEvent_WarehouseDeleted_Fragment | CalculateTaxesEvent_WarehouseMetadataUpdated_Fragment | CalculateTaxesEvent_WarehouseUpdated_Fragment; +export type CalculateTaxesEventFragment = { __typename: 'CalculateTaxes', issuedAt?: string | null, version?: string | null, taxBase: { __typename?: 'TaxableObject', pricesEnteredWithTax: boolean, currency: string, channel: { __typename?: 'Channel', slug: string, id: string }, discounts: Array<{ __typename?: 'TaxableObjectDiscount', type: TaxableObjectDiscountTypeEnum, amount: { __typename?: 'Money', amount: number } }>, address?: { __typename?: 'Address', streetAddress1: string, streetAddress2: string, city: string, countryArea: string, postalCode: string, country: { __typename?: 'CountryDisplay', code: string } } | null, shippingPrice: { __typename?: 'Money', amount: number }, lines: Array<{ __typename?: 'TaxableObjectLine', quantity: number, sourceLine: { __typename: 'CheckoutLine', id: string, checkoutProductVariant: { __typename?: 'ProductVariant', id: string, sku?: string | null, product: { __typename?: 'Product', taxClass?: { __typename?: 'TaxClass', id: string, name: string } | null } } } | { __typename: 'OrderLine', id: string, orderProductVariant?: { __typename?: 'ProductVariant', id: string, sku?: string | null, product: { __typename?: 'Product', taxClass?: { __typename?: 'TaxClass', id: string, name: string } | null } } | null }, unitPrice: { __typename?: 'Money', amount: number }, totalPrice: { __typename?: 'Money', amount: number } }>, sourceObject: { __typename: 'Checkout', id: string, avataxEntityCode?: string | null, avataxCustomerCode?: string | null, avataxExemptionStatus?: string | null, avataxShipFromAddress?: string | null, user?: { __typename?: 'User', id: string, email: string, avataxCustomerCode?: string | null } | null } | { __typename: 'Order', id: string, avataxEntityCode?: string | null, avataxCustomerCode?: string | null, avataxExemptionStatus?: string | null, avataxShipFromAddress?: string | null, user?: { __typename?: 'User', id: string, email: string, avataxCustomerCode?: string | null } | null } }, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null }; export type ChannelFragment = { __typename?: 'Channel', id: string, name: string, slug: string }; @@ -33559,6 +31599,8 @@ type WebhookMetadata_CheckoutCreated_Fragment = { __typename?: 'CheckoutCreated' type WebhookMetadata_CheckoutFilterShippingMethods_Fragment = { __typename?: 'CheckoutFilterShippingMethods', issuedAt?: string | null, version?: string | null }; +type WebhookMetadata_CheckoutFullyAuthorized_Fragment = { __typename?: 'CheckoutFullyAuthorized', issuedAt?: string | null, version?: string | null }; + type WebhookMetadata_CheckoutFullyPaid_Fragment = { __typename?: 'CheckoutFullyPaid', issuedAt?: string | null, version?: string | null }; type WebhookMetadata_CheckoutMetadataUpdated_Fragment = { __typename?: 'CheckoutMetadataUpdated', issuedAt?: string | null, version?: string | null }; @@ -33817,7 +31859,7 @@ type WebhookMetadata_WarehouseMetadataUpdated_Fragment = { __typename?: 'Warehou type WebhookMetadata_WarehouseUpdated_Fragment = { __typename?: 'WarehouseUpdated', issuedAt?: string | null, version?: string | null }; -export type WebhookMetadataFragment = WebhookMetadata_AccountChangeEmailRequested_Fragment | WebhookMetadata_AccountConfirmationRequested_Fragment | WebhookMetadata_AccountConfirmed_Fragment | WebhookMetadata_AccountDeleteRequested_Fragment | WebhookMetadata_AccountDeleted_Fragment | WebhookMetadata_AccountEmailChanged_Fragment | WebhookMetadata_AccountSetPasswordRequested_Fragment | WebhookMetadata_AddressCreated_Fragment | WebhookMetadata_AddressDeleted_Fragment | WebhookMetadata_AddressUpdated_Fragment | WebhookMetadata_AppDeleted_Fragment | WebhookMetadata_AppInstalled_Fragment | WebhookMetadata_AppStatusChanged_Fragment | WebhookMetadata_AppUpdated_Fragment | WebhookMetadata_AttributeCreated_Fragment | WebhookMetadata_AttributeDeleted_Fragment | WebhookMetadata_AttributeUpdated_Fragment | WebhookMetadata_AttributeValueCreated_Fragment | WebhookMetadata_AttributeValueDeleted_Fragment | WebhookMetadata_AttributeValueUpdated_Fragment | WebhookMetadata_CalculateTaxes_Fragment | WebhookMetadata_CategoryCreated_Fragment | WebhookMetadata_CategoryDeleted_Fragment | WebhookMetadata_CategoryUpdated_Fragment | WebhookMetadata_ChannelCreated_Fragment | WebhookMetadata_ChannelDeleted_Fragment | WebhookMetadata_ChannelMetadataUpdated_Fragment | WebhookMetadata_ChannelStatusChanged_Fragment | WebhookMetadata_ChannelUpdated_Fragment | WebhookMetadata_CheckoutCreated_Fragment | WebhookMetadata_CheckoutFilterShippingMethods_Fragment | WebhookMetadata_CheckoutFullyPaid_Fragment | WebhookMetadata_CheckoutMetadataUpdated_Fragment | WebhookMetadata_CheckoutUpdated_Fragment | WebhookMetadata_CollectionCreated_Fragment | WebhookMetadata_CollectionDeleted_Fragment | WebhookMetadata_CollectionMetadataUpdated_Fragment | WebhookMetadata_CollectionUpdated_Fragment | WebhookMetadata_CustomerCreated_Fragment | WebhookMetadata_CustomerMetadataUpdated_Fragment | WebhookMetadata_CustomerUpdated_Fragment | WebhookMetadata_DraftOrderCreated_Fragment | WebhookMetadata_DraftOrderDeleted_Fragment | WebhookMetadata_DraftOrderUpdated_Fragment | WebhookMetadata_FulfillmentApproved_Fragment | WebhookMetadata_FulfillmentCanceled_Fragment | WebhookMetadata_FulfillmentCreated_Fragment | WebhookMetadata_FulfillmentMetadataUpdated_Fragment | WebhookMetadata_FulfillmentTrackingNumberUpdated_Fragment | WebhookMetadata_GiftCardCreated_Fragment | WebhookMetadata_GiftCardDeleted_Fragment | WebhookMetadata_GiftCardExportCompleted_Fragment | WebhookMetadata_GiftCardMetadataUpdated_Fragment | WebhookMetadata_GiftCardSent_Fragment | WebhookMetadata_GiftCardStatusChanged_Fragment | WebhookMetadata_GiftCardUpdated_Fragment | WebhookMetadata_InvoiceDeleted_Fragment | WebhookMetadata_InvoiceRequested_Fragment | WebhookMetadata_InvoiceSent_Fragment | WebhookMetadata_ListStoredPaymentMethods_Fragment | WebhookMetadata_MenuCreated_Fragment | WebhookMetadata_MenuDeleted_Fragment | WebhookMetadata_MenuItemCreated_Fragment | WebhookMetadata_MenuItemDeleted_Fragment | WebhookMetadata_MenuItemUpdated_Fragment | WebhookMetadata_MenuUpdated_Fragment | WebhookMetadata_OrderBulkCreated_Fragment | WebhookMetadata_OrderCancelled_Fragment | WebhookMetadata_OrderConfirmed_Fragment | WebhookMetadata_OrderCreated_Fragment | WebhookMetadata_OrderExpired_Fragment | WebhookMetadata_OrderFilterShippingMethods_Fragment | WebhookMetadata_OrderFulfilled_Fragment | WebhookMetadata_OrderFullyPaid_Fragment | WebhookMetadata_OrderFullyRefunded_Fragment | WebhookMetadata_OrderMetadataUpdated_Fragment | WebhookMetadata_OrderPaid_Fragment | WebhookMetadata_OrderRefunded_Fragment | WebhookMetadata_OrderUpdated_Fragment | WebhookMetadata_PageCreated_Fragment | WebhookMetadata_PageDeleted_Fragment | WebhookMetadata_PageTypeCreated_Fragment | WebhookMetadata_PageTypeDeleted_Fragment | WebhookMetadata_PageTypeUpdated_Fragment | WebhookMetadata_PageUpdated_Fragment | WebhookMetadata_PaymentAuthorize_Fragment | WebhookMetadata_PaymentCaptureEvent_Fragment | WebhookMetadata_PaymentConfirmEvent_Fragment | WebhookMetadata_PaymentGatewayInitializeSession_Fragment | WebhookMetadata_PaymentGatewayInitializeTokenizationSession_Fragment | WebhookMetadata_PaymentListGateways_Fragment | WebhookMetadata_PaymentMethodInitializeTokenizationSession_Fragment | WebhookMetadata_PaymentMethodProcessTokenizationSession_Fragment | WebhookMetadata_PaymentProcessEvent_Fragment | WebhookMetadata_PaymentRefundEvent_Fragment | WebhookMetadata_PaymentVoidEvent_Fragment | WebhookMetadata_PermissionGroupCreated_Fragment | WebhookMetadata_PermissionGroupDeleted_Fragment | WebhookMetadata_PermissionGroupUpdated_Fragment | WebhookMetadata_ProductCreated_Fragment | WebhookMetadata_ProductDeleted_Fragment | WebhookMetadata_ProductExportCompleted_Fragment | WebhookMetadata_ProductMediaCreated_Fragment | WebhookMetadata_ProductMediaDeleted_Fragment | WebhookMetadata_ProductMediaUpdated_Fragment | WebhookMetadata_ProductMetadataUpdated_Fragment | WebhookMetadata_ProductUpdated_Fragment | WebhookMetadata_ProductVariantBackInStock_Fragment | WebhookMetadata_ProductVariantCreated_Fragment | WebhookMetadata_ProductVariantDeleted_Fragment | WebhookMetadata_ProductVariantMetadataUpdated_Fragment | WebhookMetadata_ProductVariantOutOfStock_Fragment | WebhookMetadata_ProductVariantStockUpdated_Fragment | WebhookMetadata_ProductVariantUpdated_Fragment | WebhookMetadata_PromotionCreated_Fragment | WebhookMetadata_PromotionDeleted_Fragment | WebhookMetadata_PromotionEnded_Fragment | WebhookMetadata_PromotionRuleCreated_Fragment | WebhookMetadata_PromotionRuleDeleted_Fragment | WebhookMetadata_PromotionRuleUpdated_Fragment | WebhookMetadata_PromotionStarted_Fragment | WebhookMetadata_PromotionUpdated_Fragment | WebhookMetadata_SaleCreated_Fragment | WebhookMetadata_SaleDeleted_Fragment | WebhookMetadata_SaleToggle_Fragment | WebhookMetadata_SaleUpdated_Fragment | WebhookMetadata_ShippingListMethodsForCheckout_Fragment | WebhookMetadata_ShippingPriceCreated_Fragment | WebhookMetadata_ShippingPriceDeleted_Fragment | WebhookMetadata_ShippingPriceUpdated_Fragment | WebhookMetadata_ShippingZoneCreated_Fragment | WebhookMetadata_ShippingZoneDeleted_Fragment | WebhookMetadata_ShippingZoneMetadataUpdated_Fragment | WebhookMetadata_ShippingZoneUpdated_Fragment | WebhookMetadata_ShopMetadataUpdated_Fragment | WebhookMetadata_StaffCreated_Fragment | WebhookMetadata_StaffDeleted_Fragment | WebhookMetadata_StaffSetPasswordRequested_Fragment | WebhookMetadata_StaffUpdated_Fragment | WebhookMetadata_StoredPaymentMethodDeleteRequested_Fragment | WebhookMetadata_ThumbnailCreated_Fragment | WebhookMetadata_TransactionCancelationRequested_Fragment | WebhookMetadata_TransactionChargeRequested_Fragment | WebhookMetadata_TransactionInitializeSession_Fragment | WebhookMetadata_TransactionItemMetadataUpdated_Fragment | WebhookMetadata_TransactionProcessSession_Fragment | WebhookMetadata_TransactionRefundRequested_Fragment | WebhookMetadata_TranslationCreated_Fragment | WebhookMetadata_TranslationUpdated_Fragment | WebhookMetadata_VoucherCodeExportCompleted_Fragment | WebhookMetadata_VoucherCodesCreated_Fragment | WebhookMetadata_VoucherCodesDeleted_Fragment | WebhookMetadata_VoucherCreated_Fragment | WebhookMetadata_VoucherDeleted_Fragment | WebhookMetadata_VoucherMetadataUpdated_Fragment | WebhookMetadata_VoucherUpdated_Fragment | WebhookMetadata_WarehouseCreated_Fragment | WebhookMetadata_WarehouseDeleted_Fragment | WebhookMetadata_WarehouseMetadataUpdated_Fragment | WebhookMetadata_WarehouseUpdated_Fragment; +export type WebhookMetadataFragment = WebhookMetadata_AccountChangeEmailRequested_Fragment | WebhookMetadata_AccountConfirmationRequested_Fragment | WebhookMetadata_AccountConfirmed_Fragment | WebhookMetadata_AccountDeleteRequested_Fragment | WebhookMetadata_AccountDeleted_Fragment | WebhookMetadata_AccountEmailChanged_Fragment | WebhookMetadata_AccountSetPasswordRequested_Fragment | WebhookMetadata_AddressCreated_Fragment | WebhookMetadata_AddressDeleted_Fragment | WebhookMetadata_AddressUpdated_Fragment | WebhookMetadata_AppDeleted_Fragment | WebhookMetadata_AppInstalled_Fragment | WebhookMetadata_AppStatusChanged_Fragment | WebhookMetadata_AppUpdated_Fragment | WebhookMetadata_AttributeCreated_Fragment | WebhookMetadata_AttributeDeleted_Fragment | WebhookMetadata_AttributeUpdated_Fragment | WebhookMetadata_AttributeValueCreated_Fragment | WebhookMetadata_AttributeValueDeleted_Fragment | WebhookMetadata_AttributeValueUpdated_Fragment | WebhookMetadata_CalculateTaxes_Fragment | WebhookMetadata_CategoryCreated_Fragment | WebhookMetadata_CategoryDeleted_Fragment | WebhookMetadata_CategoryUpdated_Fragment | WebhookMetadata_ChannelCreated_Fragment | WebhookMetadata_ChannelDeleted_Fragment | WebhookMetadata_ChannelMetadataUpdated_Fragment | WebhookMetadata_ChannelStatusChanged_Fragment | WebhookMetadata_ChannelUpdated_Fragment | WebhookMetadata_CheckoutCreated_Fragment | WebhookMetadata_CheckoutFilterShippingMethods_Fragment | WebhookMetadata_CheckoutFullyAuthorized_Fragment | WebhookMetadata_CheckoutFullyPaid_Fragment | WebhookMetadata_CheckoutMetadataUpdated_Fragment | WebhookMetadata_CheckoutUpdated_Fragment | WebhookMetadata_CollectionCreated_Fragment | WebhookMetadata_CollectionDeleted_Fragment | WebhookMetadata_CollectionMetadataUpdated_Fragment | WebhookMetadata_CollectionUpdated_Fragment | WebhookMetadata_CustomerCreated_Fragment | WebhookMetadata_CustomerMetadataUpdated_Fragment | WebhookMetadata_CustomerUpdated_Fragment | WebhookMetadata_DraftOrderCreated_Fragment | WebhookMetadata_DraftOrderDeleted_Fragment | WebhookMetadata_DraftOrderUpdated_Fragment | WebhookMetadata_FulfillmentApproved_Fragment | WebhookMetadata_FulfillmentCanceled_Fragment | WebhookMetadata_FulfillmentCreated_Fragment | WebhookMetadata_FulfillmentMetadataUpdated_Fragment | WebhookMetadata_FulfillmentTrackingNumberUpdated_Fragment | WebhookMetadata_GiftCardCreated_Fragment | WebhookMetadata_GiftCardDeleted_Fragment | WebhookMetadata_GiftCardExportCompleted_Fragment | WebhookMetadata_GiftCardMetadataUpdated_Fragment | WebhookMetadata_GiftCardSent_Fragment | WebhookMetadata_GiftCardStatusChanged_Fragment | WebhookMetadata_GiftCardUpdated_Fragment | WebhookMetadata_InvoiceDeleted_Fragment | WebhookMetadata_InvoiceRequested_Fragment | WebhookMetadata_InvoiceSent_Fragment | WebhookMetadata_ListStoredPaymentMethods_Fragment | WebhookMetadata_MenuCreated_Fragment | WebhookMetadata_MenuDeleted_Fragment | WebhookMetadata_MenuItemCreated_Fragment | WebhookMetadata_MenuItemDeleted_Fragment | WebhookMetadata_MenuItemUpdated_Fragment | WebhookMetadata_MenuUpdated_Fragment | WebhookMetadata_OrderBulkCreated_Fragment | WebhookMetadata_OrderCancelled_Fragment | WebhookMetadata_OrderConfirmed_Fragment | WebhookMetadata_OrderCreated_Fragment | WebhookMetadata_OrderExpired_Fragment | WebhookMetadata_OrderFilterShippingMethods_Fragment | WebhookMetadata_OrderFulfilled_Fragment | WebhookMetadata_OrderFullyPaid_Fragment | WebhookMetadata_OrderFullyRefunded_Fragment | WebhookMetadata_OrderMetadataUpdated_Fragment | WebhookMetadata_OrderPaid_Fragment | WebhookMetadata_OrderRefunded_Fragment | WebhookMetadata_OrderUpdated_Fragment | WebhookMetadata_PageCreated_Fragment | WebhookMetadata_PageDeleted_Fragment | WebhookMetadata_PageTypeCreated_Fragment | WebhookMetadata_PageTypeDeleted_Fragment | WebhookMetadata_PageTypeUpdated_Fragment | WebhookMetadata_PageUpdated_Fragment | WebhookMetadata_PaymentAuthorize_Fragment | WebhookMetadata_PaymentCaptureEvent_Fragment | WebhookMetadata_PaymentConfirmEvent_Fragment | WebhookMetadata_PaymentGatewayInitializeSession_Fragment | WebhookMetadata_PaymentGatewayInitializeTokenizationSession_Fragment | WebhookMetadata_PaymentListGateways_Fragment | WebhookMetadata_PaymentMethodInitializeTokenizationSession_Fragment | WebhookMetadata_PaymentMethodProcessTokenizationSession_Fragment | WebhookMetadata_PaymentProcessEvent_Fragment | WebhookMetadata_PaymentRefundEvent_Fragment | WebhookMetadata_PaymentVoidEvent_Fragment | WebhookMetadata_PermissionGroupCreated_Fragment | WebhookMetadata_PermissionGroupDeleted_Fragment | WebhookMetadata_PermissionGroupUpdated_Fragment | WebhookMetadata_ProductCreated_Fragment | WebhookMetadata_ProductDeleted_Fragment | WebhookMetadata_ProductExportCompleted_Fragment | WebhookMetadata_ProductMediaCreated_Fragment | WebhookMetadata_ProductMediaDeleted_Fragment | WebhookMetadata_ProductMediaUpdated_Fragment | WebhookMetadata_ProductMetadataUpdated_Fragment | WebhookMetadata_ProductUpdated_Fragment | WebhookMetadata_ProductVariantBackInStock_Fragment | WebhookMetadata_ProductVariantCreated_Fragment | WebhookMetadata_ProductVariantDeleted_Fragment | WebhookMetadata_ProductVariantMetadataUpdated_Fragment | WebhookMetadata_ProductVariantOutOfStock_Fragment | WebhookMetadata_ProductVariantStockUpdated_Fragment | WebhookMetadata_ProductVariantUpdated_Fragment | WebhookMetadata_PromotionCreated_Fragment | WebhookMetadata_PromotionDeleted_Fragment | WebhookMetadata_PromotionEnded_Fragment | WebhookMetadata_PromotionRuleCreated_Fragment | WebhookMetadata_PromotionRuleDeleted_Fragment | WebhookMetadata_PromotionRuleUpdated_Fragment | WebhookMetadata_PromotionStarted_Fragment | WebhookMetadata_PromotionUpdated_Fragment | WebhookMetadata_SaleCreated_Fragment | WebhookMetadata_SaleDeleted_Fragment | WebhookMetadata_SaleToggle_Fragment | WebhookMetadata_SaleUpdated_Fragment | WebhookMetadata_ShippingListMethodsForCheckout_Fragment | WebhookMetadata_ShippingPriceCreated_Fragment | WebhookMetadata_ShippingPriceDeleted_Fragment | WebhookMetadata_ShippingPriceUpdated_Fragment | WebhookMetadata_ShippingZoneCreated_Fragment | WebhookMetadata_ShippingZoneDeleted_Fragment | WebhookMetadata_ShippingZoneMetadataUpdated_Fragment | WebhookMetadata_ShippingZoneUpdated_Fragment | WebhookMetadata_ShopMetadataUpdated_Fragment | WebhookMetadata_StaffCreated_Fragment | WebhookMetadata_StaffDeleted_Fragment | WebhookMetadata_StaffSetPasswordRequested_Fragment | WebhookMetadata_StaffUpdated_Fragment | WebhookMetadata_StoredPaymentMethodDeleteRequested_Fragment | WebhookMetadata_ThumbnailCreated_Fragment | WebhookMetadata_TransactionCancelationRequested_Fragment | WebhookMetadata_TransactionChargeRequested_Fragment | WebhookMetadata_TransactionInitializeSession_Fragment | WebhookMetadata_TransactionItemMetadataUpdated_Fragment | WebhookMetadata_TransactionProcessSession_Fragment | WebhookMetadata_TransactionRefundRequested_Fragment | WebhookMetadata_TranslationCreated_Fragment | WebhookMetadata_TranslationUpdated_Fragment | WebhookMetadata_VoucherCodeExportCompleted_Fragment | WebhookMetadata_VoucherCodesCreated_Fragment | WebhookMetadata_VoucherCodesDeleted_Fragment | WebhookMetadata_VoucherCreated_Fragment | WebhookMetadata_VoucherDeleted_Fragment | WebhookMetadata_VoucherMetadataUpdated_Fragment | WebhookMetadata_VoucherUpdated_Fragment | WebhookMetadata_WarehouseCreated_Fragment | WebhookMetadata_WarehouseDeleted_Fragment | WebhookMetadata_WarehouseMetadataUpdated_Fragment | WebhookMetadata_WarehouseUpdated_Fragment; export type DeleteAppMetadataMutationVariables = Exact<{ id: Scalars['ID']['input']; @@ -33932,7 +31974,7 @@ export type CountryWithCodeFragment = { __typename: 'CountryDisplay', country: s export type CalculateTaxesSubscriptionVariables = Exact<{ [key: string]: never; }>; -export type CalculateTaxesSubscription = { __typename?: 'Subscription', event?: { __typename: 'AccountChangeEmailRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'AccountConfirmationRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'AccountConfirmed', issuedAt?: string | null, version?: string | null } | { __typename: 'AccountDeleteRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'AccountDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'AccountEmailChanged', issuedAt?: string | null, version?: string | null } | { __typename: 'AccountSetPasswordRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'AddressCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'AddressDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'AddressUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'AppDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'AppInstalled', issuedAt?: string | null, version?: string | null } | { __typename: 'AppStatusChanged', issuedAt?: string | null, version?: string | null } | { __typename: 'AppUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'AttributeCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'AttributeDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'AttributeUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'AttributeValueCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'AttributeValueDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'AttributeValueUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CalculateTaxes', issuedAt?: string | null, version?: string | null, taxBase: { __typename?: 'TaxableObject', pricesEnteredWithTax: boolean, currency: string, channel: { __typename?: 'Channel', slug: string, id: string }, discounts: Array<{ __typename?: 'TaxableObjectDiscount', type: TaxableObjectDiscountTypeEnum, amount: { __typename?: 'Money', amount: number } }>, address?: { __typename?: 'Address', streetAddress1: string, streetAddress2: string, city: string, countryArea: string, postalCode: string, country: { __typename?: 'CountryDisplay', code: string } } | null, shippingPrice: { __typename?: 'Money', amount: number }, lines: Array<{ __typename?: 'TaxableObjectLine', quantity: number, sourceLine: { __typename: 'CheckoutLine', id: string, checkoutProductVariant: { __typename?: 'ProductVariant', id: string, sku?: string | null, product: { __typename?: 'Product', taxClass?: { __typename?: 'TaxClass', id: string, name: string } | null } } } | { __typename: 'OrderLine', id: string, orderProductVariant?: { __typename?: 'ProductVariant', id: string, sku?: string | null, product: { __typename?: 'Product', taxClass?: { __typename?: 'TaxClass', id: string, name: string } | null } } | null }, unitPrice: { __typename?: 'Money', amount: number }, totalPrice: { __typename?: 'Money', amount: number } }>, sourceObject: { __typename: 'Checkout', id: string, avataxEntityCode?: string | null, avataxCustomerCode?: string | null, avataxExemptionStatus?: string | null, avataxShipFromAddress?: string | null, user?: { __typename?: 'User', id: string, email: string, avataxCustomerCode?: string | null } | null } | { __typename: 'Order', id: string, avataxEntityCode?: string | null, avataxCustomerCode?: string | null, avataxExemptionStatus?: string | null, avataxShipFromAddress?: string | null, user?: { __typename?: 'User', id: string, email: string, avataxCustomerCode?: string | null } | null } }, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CategoryCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'CategoryDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'CategoryUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ChannelCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'ChannelDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ChannelMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ChannelStatusChanged', issuedAt?: string | null, version?: string | null } | { __typename: 'ChannelUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CheckoutCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'CheckoutFilterShippingMethods', issuedAt?: string | null, version?: string | null } | { __typename: 'CheckoutFullyPaid', issuedAt?: string | null, version?: string | null } | { __typename: 'CheckoutMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CheckoutUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CollectionCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'CollectionDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'CollectionMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CollectionUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CustomerCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'CustomerMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CustomerUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'DraftOrderCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'DraftOrderDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'DraftOrderUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'FulfillmentApproved', issuedAt?: string | null, version?: string | null } | { __typename: 'FulfillmentCanceled', issuedAt?: string | null, version?: string | null } | { __typename: 'FulfillmentCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'FulfillmentMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'FulfillmentTrackingNumberUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardExportCompleted', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardSent', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardStatusChanged', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'InvoiceDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'InvoiceRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'InvoiceSent', issuedAt?: string | null, version?: string | null } | { __typename: 'ListStoredPaymentMethods', issuedAt?: string | null, version?: string | null } | { __typename: 'MenuCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'MenuDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'MenuItemCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'MenuItemDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'MenuItemUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'MenuUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderBulkCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderCancelled', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderConfirmed', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderExpired', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderFilterShippingMethods', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderFulfilled', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderFullyPaid', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderFullyRefunded', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderPaid', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderRefunded', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'PageCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'PageDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'PageTypeCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'PageTypeDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'PageTypeUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'PageUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentAuthorize', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentCaptureEvent', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentConfirmEvent', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentGatewayInitializeSession', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentGatewayInitializeTokenizationSession', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentListGateways', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentMethodInitializeTokenizationSession', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentMethodProcessTokenizationSession', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentProcessEvent', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentRefundEvent', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentVoidEvent', issuedAt?: string | null, version?: string | null } | { __typename: 'PermissionGroupCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'PermissionGroupDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'PermissionGroupUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductExportCompleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductMediaCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductMediaDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductMediaUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantBackInStock', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantOutOfStock', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantStockUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionEnded', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionRuleCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionRuleDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionRuleUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionStarted', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'SaleCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'SaleDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'SaleToggle', issuedAt?: string | null, version?: string | null } | { __typename: 'SaleUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingListMethodsForCheckout', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingPriceCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingPriceDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingPriceUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingZoneCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingZoneDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingZoneMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingZoneUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ShopMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'StaffCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'StaffDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'StaffSetPasswordRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'StaffUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'StoredPaymentMethodDeleteRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'ThumbnailCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'TransactionCancelationRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'TransactionChargeRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'TransactionInitializeSession', issuedAt?: string | null, version?: string | null } | { __typename: 'TransactionItemMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'TransactionProcessSession', issuedAt?: string | null, version?: string | null } | { __typename: 'TransactionRefundRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'TranslationCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'TranslationUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherCodeExportCompleted', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherCodesCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherCodesDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'WarehouseCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'WarehouseDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'WarehouseMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'WarehouseUpdated', issuedAt?: string | null, version?: string | null } | null }; +export type CalculateTaxesSubscription = { __typename?: 'Subscription', calculateTaxes?: { __typename?: 'CalculateTaxes', taxBase: { __typename?: 'TaxableObject', pricesEnteredWithTax: boolean, currency: string, channel: { __typename?: 'Channel', slug: string, id: string }, discounts: Array<{ __typename?: 'TaxableObjectDiscount', type: TaxableObjectDiscountTypeEnum, amount: { __typename?: 'Money', amount: number } }>, address?: { __typename?: 'Address', streetAddress1: string, streetAddress2: string, city: string, countryArea: string, postalCode: string, country: { __typename?: 'CountryDisplay', code: string } } | null, shippingPrice: { __typename?: 'Money', amount: number }, lines: Array<{ __typename?: 'TaxableObjectLine', quantity: number, sourceLine: { __typename: 'CheckoutLine', id: string, checkoutProductVariant: { __typename?: 'ProductVariant', id: string, sku?: string | null, product: { __typename?: 'Product', taxClass?: { __typename?: 'TaxClass', id: string, name: string } | null } } } | { __typename: 'OrderLine', id: string, orderProductVariant?: { __typename?: 'ProductVariant', id: string, sku?: string | null, product: { __typename?: 'Product', taxClass?: { __typename?: 'TaxClass', id: string, name: string } | null } } | null }, unitPrice: { __typename?: 'Money', amount: number }, totalPrice: { __typename?: 'Money', amount: number } }>, sourceObject: { __typename: 'Checkout', id: string, avataxEntityCode?: string | null, avataxCustomerCode?: string | null, avataxExemptionStatus?: string | null, avataxShipFromAddress?: string | null, user?: { __typename?: 'User', id: string, email: string, avataxCustomerCode?: string | null } | null } | { __typename: 'Order', id: string, avataxEntityCode?: string | null, avataxCustomerCode?: string | null, avataxExemptionStatus?: string | null, avataxShipFromAddress?: string | null, user?: { __typename?: 'User', id: string, email: string, avataxCustomerCode?: string | null } | null } }, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | null }; export type OrderCancelledSubscriptionFragment = { __typename?: 'Order', id: string, avataxId?: string | null, channel: { __typename?: 'Channel', id: string, slug: string } }; @@ -33998,6 +32040,8 @@ type OrderCancelledEventSubscription_CheckoutCreated_Fragment = { __typename: 'C type OrderCancelledEventSubscription_CheckoutFilterShippingMethods_Fragment = { __typename: 'CheckoutFilterShippingMethods', issuedAt?: string | null, version?: string | null }; +type OrderCancelledEventSubscription_CheckoutFullyAuthorized_Fragment = { __typename: 'CheckoutFullyAuthorized', issuedAt?: string | null, version?: string | null }; + type OrderCancelledEventSubscription_CheckoutFullyPaid_Fragment = { __typename: 'CheckoutFullyPaid', issuedAt?: string | null, version?: string | null }; type OrderCancelledEventSubscription_CheckoutMetadataUpdated_Fragment = { __typename: 'CheckoutMetadataUpdated', issuedAt?: string | null, version?: string | null }; @@ -34256,12 +32300,12 @@ type OrderCancelledEventSubscription_WarehouseMetadataUpdated_Fragment = { __typ type OrderCancelledEventSubscription_WarehouseUpdated_Fragment = { __typename: 'WarehouseUpdated', issuedAt?: string | null, version?: string | null }; -export type OrderCancelledEventSubscriptionFragment = OrderCancelledEventSubscription_AccountChangeEmailRequested_Fragment | OrderCancelledEventSubscription_AccountConfirmationRequested_Fragment | OrderCancelledEventSubscription_AccountConfirmed_Fragment | OrderCancelledEventSubscription_AccountDeleteRequested_Fragment | OrderCancelledEventSubscription_AccountDeleted_Fragment | OrderCancelledEventSubscription_AccountEmailChanged_Fragment | OrderCancelledEventSubscription_AccountSetPasswordRequested_Fragment | OrderCancelledEventSubscription_AddressCreated_Fragment | OrderCancelledEventSubscription_AddressDeleted_Fragment | OrderCancelledEventSubscription_AddressUpdated_Fragment | OrderCancelledEventSubscription_AppDeleted_Fragment | OrderCancelledEventSubscription_AppInstalled_Fragment | OrderCancelledEventSubscription_AppStatusChanged_Fragment | OrderCancelledEventSubscription_AppUpdated_Fragment | OrderCancelledEventSubscription_AttributeCreated_Fragment | OrderCancelledEventSubscription_AttributeDeleted_Fragment | OrderCancelledEventSubscription_AttributeUpdated_Fragment | OrderCancelledEventSubscription_AttributeValueCreated_Fragment | OrderCancelledEventSubscription_AttributeValueDeleted_Fragment | OrderCancelledEventSubscription_AttributeValueUpdated_Fragment | OrderCancelledEventSubscription_CalculateTaxes_Fragment | OrderCancelledEventSubscription_CategoryCreated_Fragment | OrderCancelledEventSubscription_CategoryDeleted_Fragment | OrderCancelledEventSubscription_CategoryUpdated_Fragment | OrderCancelledEventSubscription_ChannelCreated_Fragment | OrderCancelledEventSubscription_ChannelDeleted_Fragment | OrderCancelledEventSubscription_ChannelMetadataUpdated_Fragment | OrderCancelledEventSubscription_ChannelStatusChanged_Fragment | OrderCancelledEventSubscription_ChannelUpdated_Fragment | OrderCancelledEventSubscription_CheckoutCreated_Fragment | OrderCancelledEventSubscription_CheckoutFilterShippingMethods_Fragment | OrderCancelledEventSubscription_CheckoutFullyPaid_Fragment | OrderCancelledEventSubscription_CheckoutMetadataUpdated_Fragment | OrderCancelledEventSubscription_CheckoutUpdated_Fragment | OrderCancelledEventSubscription_CollectionCreated_Fragment | OrderCancelledEventSubscription_CollectionDeleted_Fragment | OrderCancelledEventSubscription_CollectionMetadataUpdated_Fragment | OrderCancelledEventSubscription_CollectionUpdated_Fragment | OrderCancelledEventSubscription_CustomerCreated_Fragment | OrderCancelledEventSubscription_CustomerMetadataUpdated_Fragment | OrderCancelledEventSubscription_CustomerUpdated_Fragment | OrderCancelledEventSubscription_DraftOrderCreated_Fragment | OrderCancelledEventSubscription_DraftOrderDeleted_Fragment | OrderCancelledEventSubscription_DraftOrderUpdated_Fragment | OrderCancelledEventSubscription_FulfillmentApproved_Fragment | OrderCancelledEventSubscription_FulfillmentCanceled_Fragment | OrderCancelledEventSubscription_FulfillmentCreated_Fragment | OrderCancelledEventSubscription_FulfillmentMetadataUpdated_Fragment | OrderCancelledEventSubscription_FulfillmentTrackingNumberUpdated_Fragment | OrderCancelledEventSubscription_GiftCardCreated_Fragment | OrderCancelledEventSubscription_GiftCardDeleted_Fragment | OrderCancelledEventSubscription_GiftCardExportCompleted_Fragment | OrderCancelledEventSubscription_GiftCardMetadataUpdated_Fragment | OrderCancelledEventSubscription_GiftCardSent_Fragment | OrderCancelledEventSubscription_GiftCardStatusChanged_Fragment | OrderCancelledEventSubscription_GiftCardUpdated_Fragment | OrderCancelledEventSubscription_InvoiceDeleted_Fragment | OrderCancelledEventSubscription_InvoiceRequested_Fragment | OrderCancelledEventSubscription_InvoiceSent_Fragment | OrderCancelledEventSubscription_ListStoredPaymentMethods_Fragment | OrderCancelledEventSubscription_MenuCreated_Fragment | OrderCancelledEventSubscription_MenuDeleted_Fragment | OrderCancelledEventSubscription_MenuItemCreated_Fragment | OrderCancelledEventSubscription_MenuItemDeleted_Fragment | OrderCancelledEventSubscription_MenuItemUpdated_Fragment | OrderCancelledEventSubscription_MenuUpdated_Fragment | OrderCancelledEventSubscription_OrderBulkCreated_Fragment | OrderCancelledEventSubscription_OrderCancelled_Fragment | OrderCancelledEventSubscription_OrderConfirmed_Fragment | OrderCancelledEventSubscription_OrderCreated_Fragment | OrderCancelledEventSubscription_OrderExpired_Fragment | OrderCancelledEventSubscription_OrderFilterShippingMethods_Fragment | OrderCancelledEventSubscription_OrderFulfilled_Fragment | OrderCancelledEventSubscription_OrderFullyPaid_Fragment | OrderCancelledEventSubscription_OrderFullyRefunded_Fragment | OrderCancelledEventSubscription_OrderMetadataUpdated_Fragment | OrderCancelledEventSubscription_OrderPaid_Fragment | OrderCancelledEventSubscription_OrderRefunded_Fragment | OrderCancelledEventSubscription_OrderUpdated_Fragment | OrderCancelledEventSubscription_PageCreated_Fragment | OrderCancelledEventSubscription_PageDeleted_Fragment | OrderCancelledEventSubscription_PageTypeCreated_Fragment | OrderCancelledEventSubscription_PageTypeDeleted_Fragment | OrderCancelledEventSubscription_PageTypeUpdated_Fragment | OrderCancelledEventSubscription_PageUpdated_Fragment | OrderCancelledEventSubscription_PaymentAuthorize_Fragment | OrderCancelledEventSubscription_PaymentCaptureEvent_Fragment | OrderCancelledEventSubscription_PaymentConfirmEvent_Fragment | OrderCancelledEventSubscription_PaymentGatewayInitializeSession_Fragment | OrderCancelledEventSubscription_PaymentGatewayInitializeTokenizationSession_Fragment | OrderCancelledEventSubscription_PaymentListGateways_Fragment | OrderCancelledEventSubscription_PaymentMethodInitializeTokenizationSession_Fragment | OrderCancelledEventSubscription_PaymentMethodProcessTokenizationSession_Fragment | OrderCancelledEventSubscription_PaymentProcessEvent_Fragment | OrderCancelledEventSubscription_PaymentRefundEvent_Fragment | OrderCancelledEventSubscription_PaymentVoidEvent_Fragment | OrderCancelledEventSubscription_PermissionGroupCreated_Fragment | OrderCancelledEventSubscription_PermissionGroupDeleted_Fragment | OrderCancelledEventSubscription_PermissionGroupUpdated_Fragment | OrderCancelledEventSubscription_ProductCreated_Fragment | OrderCancelledEventSubscription_ProductDeleted_Fragment | OrderCancelledEventSubscription_ProductExportCompleted_Fragment | OrderCancelledEventSubscription_ProductMediaCreated_Fragment | OrderCancelledEventSubscription_ProductMediaDeleted_Fragment | OrderCancelledEventSubscription_ProductMediaUpdated_Fragment | OrderCancelledEventSubscription_ProductMetadataUpdated_Fragment | OrderCancelledEventSubscription_ProductUpdated_Fragment | OrderCancelledEventSubscription_ProductVariantBackInStock_Fragment | OrderCancelledEventSubscription_ProductVariantCreated_Fragment | OrderCancelledEventSubscription_ProductVariantDeleted_Fragment | OrderCancelledEventSubscription_ProductVariantMetadataUpdated_Fragment | OrderCancelledEventSubscription_ProductVariantOutOfStock_Fragment | OrderCancelledEventSubscription_ProductVariantStockUpdated_Fragment | OrderCancelledEventSubscription_ProductVariantUpdated_Fragment | OrderCancelledEventSubscription_PromotionCreated_Fragment | OrderCancelledEventSubscription_PromotionDeleted_Fragment | OrderCancelledEventSubscription_PromotionEnded_Fragment | OrderCancelledEventSubscription_PromotionRuleCreated_Fragment | OrderCancelledEventSubscription_PromotionRuleDeleted_Fragment | OrderCancelledEventSubscription_PromotionRuleUpdated_Fragment | OrderCancelledEventSubscription_PromotionStarted_Fragment | OrderCancelledEventSubscription_PromotionUpdated_Fragment | OrderCancelledEventSubscription_SaleCreated_Fragment | OrderCancelledEventSubscription_SaleDeleted_Fragment | OrderCancelledEventSubscription_SaleToggle_Fragment | OrderCancelledEventSubscription_SaleUpdated_Fragment | OrderCancelledEventSubscription_ShippingListMethodsForCheckout_Fragment | OrderCancelledEventSubscription_ShippingPriceCreated_Fragment | OrderCancelledEventSubscription_ShippingPriceDeleted_Fragment | OrderCancelledEventSubscription_ShippingPriceUpdated_Fragment | OrderCancelledEventSubscription_ShippingZoneCreated_Fragment | OrderCancelledEventSubscription_ShippingZoneDeleted_Fragment | OrderCancelledEventSubscription_ShippingZoneMetadataUpdated_Fragment | OrderCancelledEventSubscription_ShippingZoneUpdated_Fragment | OrderCancelledEventSubscription_ShopMetadataUpdated_Fragment | OrderCancelledEventSubscription_StaffCreated_Fragment | OrderCancelledEventSubscription_StaffDeleted_Fragment | OrderCancelledEventSubscription_StaffSetPasswordRequested_Fragment | OrderCancelledEventSubscription_StaffUpdated_Fragment | OrderCancelledEventSubscription_StoredPaymentMethodDeleteRequested_Fragment | OrderCancelledEventSubscription_ThumbnailCreated_Fragment | OrderCancelledEventSubscription_TransactionCancelationRequested_Fragment | OrderCancelledEventSubscription_TransactionChargeRequested_Fragment | OrderCancelledEventSubscription_TransactionInitializeSession_Fragment | OrderCancelledEventSubscription_TransactionItemMetadataUpdated_Fragment | OrderCancelledEventSubscription_TransactionProcessSession_Fragment | OrderCancelledEventSubscription_TransactionRefundRequested_Fragment | OrderCancelledEventSubscription_TranslationCreated_Fragment | OrderCancelledEventSubscription_TranslationUpdated_Fragment | OrderCancelledEventSubscription_VoucherCodeExportCompleted_Fragment | OrderCancelledEventSubscription_VoucherCodesCreated_Fragment | OrderCancelledEventSubscription_VoucherCodesDeleted_Fragment | OrderCancelledEventSubscription_VoucherCreated_Fragment | OrderCancelledEventSubscription_VoucherDeleted_Fragment | OrderCancelledEventSubscription_VoucherMetadataUpdated_Fragment | OrderCancelledEventSubscription_VoucherUpdated_Fragment | OrderCancelledEventSubscription_WarehouseCreated_Fragment | OrderCancelledEventSubscription_WarehouseDeleted_Fragment | OrderCancelledEventSubscription_WarehouseMetadataUpdated_Fragment | OrderCancelledEventSubscription_WarehouseUpdated_Fragment; +export type OrderCancelledEventSubscriptionFragment = OrderCancelledEventSubscription_AccountChangeEmailRequested_Fragment | OrderCancelledEventSubscription_AccountConfirmationRequested_Fragment | OrderCancelledEventSubscription_AccountConfirmed_Fragment | OrderCancelledEventSubscription_AccountDeleteRequested_Fragment | OrderCancelledEventSubscription_AccountDeleted_Fragment | OrderCancelledEventSubscription_AccountEmailChanged_Fragment | OrderCancelledEventSubscription_AccountSetPasswordRequested_Fragment | OrderCancelledEventSubscription_AddressCreated_Fragment | OrderCancelledEventSubscription_AddressDeleted_Fragment | OrderCancelledEventSubscription_AddressUpdated_Fragment | OrderCancelledEventSubscription_AppDeleted_Fragment | OrderCancelledEventSubscription_AppInstalled_Fragment | OrderCancelledEventSubscription_AppStatusChanged_Fragment | OrderCancelledEventSubscription_AppUpdated_Fragment | OrderCancelledEventSubscription_AttributeCreated_Fragment | OrderCancelledEventSubscription_AttributeDeleted_Fragment | OrderCancelledEventSubscription_AttributeUpdated_Fragment | OrderCancelledEventSubscription_AttributeValueCreated_Fragment | OrderCancelledEventSubscription_AttributeValueDeleted_Fragment | OrderCancelledEventSubscription_AttributeValueUpdated_Fragment | OrderCancelledEventSubscription_CalculateTaxes_Fragment | OrderCancelledEventSubscription_CategoryCreated_Fragment | OrderCancelledEventSubscription_CategoryDeleted_Fragment | OrderCancelledEventSubscription_CategoryUpdated_Fragment | OrderCancelledEventSubscription_ChannelCreated_Fragment | OrderCancelledEventSubscription_ChannelDeleted_Fragment | OrderCancelledEventSubscription_ChannelMetadataUpdated_Fragment | OrderCancelledEventSubscription_ChannelStatusChanged_Fragment | OrderCancelledEventSubscription_ChannelUpdated_Fragment | OrderCancelledEventSubscription_CheckoutCreated_Fragment | OrderCancelledEventSubscription_CheckoutFilterShippingMethods_Fragment | OrderCancelledEventSubscription_CheckoutFullyAuthorized_Fragment | OrderCancelledEventSubscription_CheckoutFullyPaid_Fragment | OrderCancelledEventSubscription_CheckoutMetadataUpdated_Fragment | OrderCancelledEventSubscription_CheckoutUpdated_Fragment | OrderCancelledEventSubscription_CollectionCreated_Fragment | OrderCancelledEventSubscription_CollectionDeleted_Fragment | OrderCancelledEventSubscription_CollectionMetadataUpdated_Fragment | OrderCancelledEventSubscription_CollectionUpdated_Fragment | OrderCancelledEventSubscription_CustomerCreated_Fragment | OrderCancelledEventSubscription_CustomerMetadataUpdated_Fragment | OrderCancelledEventSubscription_CustomerUpdated_Fragment | OrderCancelledEventSubscription_DraftOrderCreated_Fragment | OrderCancelledEventSubscription_DraftOrderDeleted_Fragment | OrderCancelledEventSubscription_DraftOrderUpdated_Fragment | OrderCancelledEventSubscription_FulfillmentApproved_Fragment | OrderCancelledEventSubscription_FulfillmentCanceled_Fragment | OrderCancelledEventSubscription_FulfillmentCreated_Fragment | OrderCancelledEventSubscription_FulfillmentMetadataUpdated_Fragment | OrderCancelledEventSubscription_FulfillmentTrackingNumberUpdated_Fragment | OrderCancelledEventSubscription_GiftCardCreated_Fragment | OrderCancelledEventSubscription_GiftCardDeleted_Fragment | OrderCancelledEventSubscription_GiftCardExportCompleted_Fragment | OrderCancelledEventSubscription_GiftCardMetadataUpdated_Fragment | OrderCancelledEventSubscription_GiftCardSent_Fragment | OrderCancelledEventSubscription_GiftCardStatusChanged_Fragment | OrderCancelledEventSubscription_GiftCardUpdated_Fragment | OrderCancelledEventSubscription_InvoiceDeleted_Fragment | OrderCancelledEventSubscription_InvoiceRequested_Fragment | OrderCancelledEventSubscription_InvoiceSent_Fragment | OrderCancelledEventSubscription_ListStoredPaymentMethods_Fragment | OrderCancelledEventSubscription_MenuCreated_Fragment | OrderCancelledEventSubscription_MenuDeleted_Fragment | OrderCancelledEventSubscription_MenuItemCreated_Fragment | OrderCancelledEventSubscription_MenuItemDeleted_Fragment | OrderCancelledEventSubscription_MenuItemUpdated_Fragment | OrderCancelledEventSubscription_MenuUpdated_Fragment | OrderCancelledEventSubscription_OrderBulkCreated_Fragment | OrderCancelledEventSubscription_OrderCancelled_Fragment | OrderCancelledEventSubscription_OrderConfirmed_Fragment | OrderCancelledEventSubscription_OrderCreated_Fragment | OrderCancelledEventSubscription_OrderExpired_Fragment | OrderCancelledEventSubscription_OrderFilterShippingMethods_Fragment | OrderCancelledEventSubscription_OrderFulfilled_Fragment | OrderCancelledEventSubscription_OrderFullyPaid_Fragment | OrderCancelledEventSubscription_OrderFullyRefunded_Fragment | OrderCancelledEventSubscription_OrderMetadataUpdated_Fragment | OrderCancelledEventSubscription_OrderPaid_Fragment | OrderCancelledEventSubscription_OrderRefunded_Fragment | OrderCancelledEventSubscription_OrderUpdated_Fragment | OrderCancelledEventSubscription_PageCreated_Fragment | OrderCancelledEventSubscription_PageDeleted_Fragment | OrderCancelledEventSubscription_PageTypeCreated_Fragment | OrderCancelledEventSubscription_PageTypeDeleted_Fragment | OrderCancelledEventSubscription_PageTypeUpdated_Fragment | OrderCancelledEventSubscription_PageUpdated_Fragment | OrderCancelledEventSubscription_PaymentAuthorize_Fragment | OrderCancelledEventSubscription_PaymentCaptureEvent_Fragment | OrderCancelledEventSubscription_PaymentConfirmEvent_Fragment | OrderCancelledEventSubscription_PaymentGatewayInitializeSession_Fragment | OrderCancelledEventSubscription_PaymentGatewayInitializeTokenizationSession_Fragment | OrderCancelledEventSubscription_PaymentListGateways_Fragment | OrderCancelledEventSubscription_PaymentMethodInitializeTokenizationSession_Fragment | OrderCancelledEventSubscription_PaymentMethodProcessTokenizationSession_Fragment | OrderCancelledEventSubscription_PaymentProcessEvent_Fragment | OrderCancelledEventSubscription_PaymentRefundEvent_Fragment | OrderCancelledEventSubscription_PaymentVoidEvent_Fragment | OrderCancelledEventSubscription_PermissionGroupCreated_Fragment | OrderCancelledEventSubscription_PermissionGroupDeleted_Fragment | OrderCancelledEventSubscription_PermissionGroupUpdated_Fragment | OrderCancelledEventSubscription_ProductCreated_Fragment | OrderCancelledEventSubscription_ProductDeleted_Fragment | OrderCancelledEventSubscription_ProductExportCompleted_Fragment | OrderCancelledEventSubscription_ProductMediaCreated_Fragment | OrderCancelledEventSubscription_ProductMediaDeleted_Fragment | OrderCancelledEventSubscription_ProductMediaUpdated_Fragment | OrderCancelledEventSubscription_ProductMetadataUpdated_Fragment | OrderCancelledEventSubscription_ProductUpdated_Fragment | OrderCancelledEventSubscription_ProductVariantBackInStock_Fragment | OrderCancelledEventSubscription_ProductVariantCreated_Fragment | OrderCancelledEventSubscription_ProductVariantDeleted_Fragment | OrderCancelledEventSubscription_ProductVariantMetadataUpdated_Fragment | OrderCancelledEventSubscription_ProductVariantOutOfStock_Fragment | OrderCancelledEventSubscription_ProductVariantStockUpdated_Fragment | OrderCancelledEventSubscription_ProductVariantUpdated_Fragment | OrderCancelledEventSubscription_PromotionCreated_Fragment | OrderCancelledEventSubscription_PromotionDeleted_Fragment | OrderCancelledEventSubscription_PromotionEnded_Fragment | OrderCancelledEventSubscription_PromotionRuleCreated_Fragment | OrderCancelledEventSubscription_PromotionRuleDeleted_Fragment | OrderCancelledEventSubscription_PromotionRuleUpdated_Fragment | OrderCancelledEventSubscription_PromotionStarted_Fragment | OrderCancelledEventSubscription_PromotionUpdated_Fragment | OrderCancelledEventSubscription_SaleCreated_Fragment | OrderCancelledEventSubscription_SaleDeleted_Fragment | OrderCancelledEventSubscription_SaleToggle_Fragment | OrderCancelledEventSubscription_SaleUpdated_Fragment | OrderCancelledEventSubscription_ShippingListMethodsForCheckout_Fragment | OrderCancelledEventSubscription_ShippingPriceCreated_Fragment | OrderCancelledEventSubscription_ShippingPriceDeleted_Fragment | OrderCancelledEventSubscription_ShippingPriceUpdated_Fragment | OrderCancelledEventSubscription_ShippingZoneCreated_Fragment | OrderCancelledEventSubscription_ShippingZoneDeleted_Fragment | OrderCancelledEventSubscription_ShippingZoneMetadataUpdated_Fragment | OrderCancelledEventSubscription_ShippingZoneUpdated_Fragment | OrderCancelledEventSubscription_ShopMetadataUpdated_Fragment | OrderCancelledEventSubscription_StaffCreated_Fragment | OrderCancelledEventSubscription_StaffDeleted_Fragment | OrderCancelledEventSubscription_StaffSetPasswordRequested_Fragment | OrderCancelledEventSubscription_StaffUpdated_Fragment | OrderCancelledEventSubscription_StoredPaymentMethodDeleteRequested_Fragment | OrderCancelledEventSubscription_ThumbnailCreated_Fragment | OrderCancelledEventSubscription_TransactionCancelationRequested_Fragment | OrderCancelledEventSubscription_TransactionChargeRequested_Fragment | OrderCancelledEventSubscription_TransactionInitializeSession_Fragment | OrderCancelledEventSubscription_TransactionItemMetadataUpdated_Fragment | OrderCancelledEventSubscription_TransactionProcessSession_Fragment | OrderCancelledEventSubscription_TransactionRefundRequested_Fragment | OrderCancelledEventSubscription_TranslationCreated_Fragment | OrderCancelledEventSubscription_TranslationUpdated_Fragment | OrderCancelledEventSubscription_VoucherCodeExportCompleted_Fragment | OrderCancelledEventSubscription_VoucherCodesCreated_Fragment | OrderCancelledEventSubscription_VoucherCodesDeleted_Fragment | OrderCancelledEventSubscription_VoucherCreated_Fragment | OrderCancelledEventSubscription_VoucherDeleted_Fragment | OrderCancelledEventSubscription_VoucherMetadataUpdated_Fragment | OrderCancelledEventSubscription_VoucherUpdated_Fragment | OrderCancelledEventSubscription_WarehouseCreated_Fragment | OrderCancelledEventSubscription_WarehouseDeleted_Fragment | OrderCancelledEventSubscription_WarehouseMetadataUpdated_Fragment | OrderCancelledEventSubscription_WarehouseUpdated_Fragment; export type OrderCancelledSubscriptionSubscriptionVariables = Exact<{ [key: string]: never; }>; -export type OrderCancelledSubscriptionSubscription = { __typename?: 'Subscription', event?: { __typename: 'AccountChangeEmailRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'AccountConfirmationRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'AccountConfirmed', issuedAt?: string | null, version?: string | null } | { __typename: 'AccountDeleteRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'AccountDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'AccountEmailChanged', issuedAt?: string | null, version?: string | null } | { __typename: 'AccountSetPasswordRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'AddressCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'AddressDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'AddressUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'AppDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'AppInstalled', issuedAt?: string | null, version?: string | null } | { __typename: 'AppStatusChanged', issuedAt?: string | null, version?: string | null } | { __typename: 'AppUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'AttributeCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'AttributeDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'AttributeUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'AttributeValueCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'AttributeValueDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'AttributeValueUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CalculateTaxes', issuedAt?: string | null, version?: string | null } | { __typename: 'CategoryCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'CategoryDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'CategoryUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ChannelCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'ChannelDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ChannelMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ChannelStatusChanged', issuedAt?: string | null, version?: string | null } | { __typename: 'ChannelUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CheckoutCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'CheckoutFilterShippingMethods', issuedAt?: string | null, version?: string | null } | { __typename: 'CheckoutFullyPaid', issuedAt?: string | null, version?: string | null } | { __typename: 'CheckoutMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CheckoutUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CollectionCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'CollectionDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'CollectionMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CollectionUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CustomerCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'CustomerMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CustomerUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'DraftOrderCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'DraftOrderDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'DraftOrderUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'FulfillmentApproved', issuedAt?: string | null, version?: string | null } | { __typename: 'FulfillmentCanceled', issuedAt?: string | null, version?: string | null } | { __typename: 'FulfillmentCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'FulfillmentMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'FulfillmentTrackingNumberUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardExportCompleted', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardSent', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardStatusChanged', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'InvoiceDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'InvoiceRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'InvoiceSent', issuedAt?: string | null, version?: string | null } | { __typename: 'ListStoredPaymentMethods', issuedAt?: string | null, version?: string | null } | { __typename: 'MenuCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'MenuDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'MenuItemCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'MenuItemDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'MenuItemUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'MenuUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderBulkCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderCancelled', issuedAt?: string | null, version?: string | null, order?: { __typename?: 'Order', id: string, avataxId?: string | null, channel: { __typename?: 'Channel', id: string, slug: string } } | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderConfirmed', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderExpired', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderFilterShippingMethods', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderFulfilled', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderFullyPaid', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderFullyRefunded', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderPaid', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderRefunded', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'PageCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'PageDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'PageTypeCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'PageTypeDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'PageTypeUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'PageUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentAuthorize', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentCaptureEvent', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentConfirmEvent', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentGatewayInitializeSession', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentGatewayInitializeTokenizationSession', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentListGateways', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentMethodInitializeTokenizationSession', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentMethodProcessTokenizationSession', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentProcessEvent', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentRefundEvent', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentVoidEvent', issuedAt?: string | null, version?: string | null } | { __typename: 'PermissionGroupCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'PermissionGroupDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'PermissionGroupUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductExportCompleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductMediaCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductMediaDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductMediaUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantBackInStock', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantOutOfStock', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantStockUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionEnded', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionRuleCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionRuleDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionRuleUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionStarted', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'SaleCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'SaleDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'SaleToggle', issuedAt?: string | null, version?: string | null } | { __typename: 'SaleUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingListMethodsForCheckout', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingPriceCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingPriceDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingPriceUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingZoneCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingZoneDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingZoneMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingZoneUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ShopMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'StaffCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'StaffDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'StaffSetPasswordRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'StaffUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'StoredPaymentMethodDeleteRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'ThumbnailCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'TransactionCancelationRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'TransactionChargeRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'TransactionInitializeSession', issuedAt?: string | null, version?: string | null } | { __typename: 'TransactionItemMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'TransactionProcessSession', issuedAt?: string | null, version?: string | null } | { __typename: 'TransactionRefundRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'TranslationCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'TranslationUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherCodeExportCompleted', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherCodesCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherCodesDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'WarehouseCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'WarehouseDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'WarehouseMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'WarehouseUpdated', issuedAt?: string | null, version?: string | null } | null }; +export type OrderCancelledSubscriptionSubscription = { __typename?: 'Subscription', event?: { __typename: 'AccountChangeEmailRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'AccountConfirmationRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'AccountConfirmed', issuedAt?: string | null, version?: string | null } | { __typename: 'AccountDeleteRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'AccountDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'AccountEmailChanged', issuedAt?: string | null, version?: string | null } | { __typename: 'AccountSetPasswordRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'AddressCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'AddressDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'AddressUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'AppDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'AppInstalled', issuedAt?: string | null, version?: string | null } | { __typename: 'AppStatusChanged', issuedAt?: string | null, version?: string | null } | { __typename: 'AppUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'AttributeCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'AttributeDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'AttributeUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'AttributeValueCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'AttributeValueDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'AttributeValueUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CalculateTaxes', issuedAt?: string | null, version?: string | null } | { __typename: 'CategoryCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'CategoryDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'CategoryUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ChannelCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'ChannelDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ChannelMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ChannelStatusChanged', issuedAt?: string | null, version?: string | null } | { __typename: 'ChannelUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CheckoutCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'CheckoutFilterShippingMethods', issuedAt?: string | null, version?: string | null } | { __typename: 'CheckoutFullyAuthorized', issuedAt?: string | null, version?: string | null } | { __typename: 'CheckoutFullyPaid', issuedAt?: string | null, version?: string | null } | { __typename: 'CheckoutMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CheckoutUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CollectionCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'CollectionDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'CollectionMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CollectionUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CustomerCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'CustomerMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'CustomerUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'DraftOrderCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'DraftOrderDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'DraftOrderUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'FulfillmentApproved', issuedAt?: string | null, version?: string | null } | { __typename: 'FulfillmentCanceled', issuedAt?: string | null, version?: string | null } | { __typename: 'FulfillmentCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'FulfillmentMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'FulfillmentTrackingNumberUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardExportCompleted', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardSent', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardStatusChanged', issuedAt?: string | null, version?: string | null } | { __typename: 'GiftCardUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'InvoiceDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'InvoiceRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'InvoiceSent', issuedAt?: string | null, version?: string | null } | { __typename: 'ListStoredPaymentMethods', issuedAt?: string | null, version?: string | null } | { __typename: 'MenuCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'MenuDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'MenuItemCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'MenuItemDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'MenuItemUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'MenuUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderBulkCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderCancelled', issuedAt?: string | null, version?: string | null, order?: { __typename?: 'Order', id: string, avataxId?: string | null, channel: { __typename?: 'Channel', id: string, slug: string } } | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderConfirmed', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderExpired', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderFilterShippingMethods', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderFulfilled', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderFullyPaid', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderFullyRefunded', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderPaid', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderRefunded', issuedAt?: string | null, version?: string | null } | { __typename: 'OrderUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'PageCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'PageDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'PageTypeCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'PageTypeDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'PageTypeUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'PageUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentAuthorize', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentCaptureEvent', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentConfirmEvent', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentGatewayInitializeSession', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentGatewayInitializeTokenizationSession', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentListGateways', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentMethodInitializeTokenizationSession', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentMethodProcessTokenizationSession', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentProcessEvent', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentRefundEvent', issuedAt?: string | null, version?: string | null } | { __typename: 'PaymentVoidEvent', issuedAt?: string | null, version?: string | null } | { __typename: 'PermissionGroupCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'PermissionGroupDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'PermissionGroupUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductExportCompleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductMediaCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductMediaDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductMediaUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantBackInStock', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantOutOfStock', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantStockUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ProductVariantUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionEnded', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionRuleCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionRuleDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionRuleUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionStarted', issuedAt?: string | null, version?: string | null } | { __typename: 'PromotionUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'SaleCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'SaleDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'SaleToggle', issuedAt?: string | null, version?: string | null } | { __typename: 'SaleUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingListMethodsForCheckout', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingPriceCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingPriceDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingPriceUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingZoneCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingZoneDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingZoneMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ShippingZoneUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'ShopMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'StaffCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'StaffDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'StaffSetPasswordRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'StaffUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'StoredPaymentMethodDeleteRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'ThumbnailCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'TransactionCancelationRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'TransactionChargeRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'TransactionInitializeSession', issuedAt?: string | null, version?: string | null } | { __typename: 'TransactionItemMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'TransactionProcessSession', issuedAt?: string | null, version?: string | null } | { __typename: 'TransactionRefundRequested', issuedAt?: string | null, version?: string | null } | { __typename: 'TranslationCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'TranslationUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherCodeExportCompleted', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherCodesCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherCodesDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'VoucherUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'WarehouseCreated', issuedAt?: string | null, version?: string | null } | { __typename: 'WarehouseDeleted', issuedAt?: string | null, version?: string | null } | { __typename: 'WarehouseMetadataUpdated', issuedAt?: string | null, version?: string | null } | { __typename: 'WarehouseUpdated', issuedAt?: string | null, version?: string | null } | null }; export type OrderLineFragment = { __typename?: 'OrderLine', productSku?: string | null, productVariantId?: string | null, productName: string, quantity: number, taxClass?: { __typename?: 'TaxClass', id: string } | null, unitPrice: { __typename?: 'TaxedMoney', net: { __typename?: 'Money', amount: number } }, totalPrice: { __typename?: 'TaxedMoney', net: { __typename?: 'Money', amount: number }, tax: { __typename?: 'Money', amount: number }, gross: { __typename?: 'Money', amount: number } } }; @@ -34329,6 +32373,8 @@ type OrderConfirmedEventSubscription_CheckoutCreated_Fragment = { __typename: 'C type OrderConfirmedEventSubscription_CheckoutFilterShippingMethods_Fragment = { __typename: 'CheckoutFilterShippingMethods', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null }; +type OrderConfirmedEventSubscription_CheckoutFullyAuthorized_Fragment = { __typename: 'CheckoutFullyAuthorized', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null }; + type OrderConfirmedEventSubscription_CheckoutFullyPaid_Fragment = { __typename: 'CheckoutFullyPaid', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null }; type OrderConfirmedEventSubscription_CheckoutMetadataUpdated_Fragment = { __typename: 'CheckoutMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null }; @@ -34587,19 +32633,13 @@ type OrderConfirmedEventSubscription_WarehouseMetadataUpdated_Fragment = { __typ type OrderConfirmedEventSubscription_WarehouseUpdated_Fragment = { __typename: 'WarehouseUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null }; -export type OrderConfirmedEventSubscriptionFragment = OrderConfirmedEventSubscription_AccountChangeEmailRequested_Fragment | OrderConfirmedEventSubscription_AccountConfirmationRequested_Fragment | OrderConfirmedEventSubscription_AccountConfirmed_Fragment | OrderConfirmedEventSubscription_AccountDeleteRequested_Fragment | OrderConfirmedEventSubscription_AccountDeleted_Fragment | OrderConfirmedEventSubscription_AccountEmailChanged_Fragment | OrderConfirmedEventSubscription_AccountSetPasswordRequested_Fragment | OrderConfirmedEventSubscription_AddressCreated_Fragment | OrderConfirmedEventSubscription_AddressDeleted_Fragment | OrderConfirmedEventSubscription_AddressUpdated_Fragment | OrderConfirmedEventSubscription_AppDeleted_Fragment | OrderConfirmedEventSubscription_AppInstalled_Fragment | OrderConfirmedEventSubscription_AppStatusChanged_Fragment | OrderConfirmedEventSubscription_AppUpdated_Fragment | OrderConfirmedEventSubscription_AttributeCreated_Fragment | OrderConfirmedEventSubscription_AttributeDeleted_Fragment | OrderConfirmedEventSubscription_AttributeUpdated_Fragment | OrderConfirmedEventSubscription_AttributeValueCreated_Fragment | OrderConfirmedEventSubscription_AttributeValueDeleted_Fragment | OrderConfirmedEventSubscription_AttributeValueUpdated_Fragment | OrderConfirmedEventSubscription_CalculateTaxes_Fragment | OrderConfirmedEventSubscription_CategoryCreated_Fragment | OrderConfirmedEventSubscription_CategoryDeleted_Fragment | OrderConfirmedEventSubscription_CategoryUpdated_Fragment | OrderConfirmedEventSubscription_ChannelCreated_Fragment | OrderConfirmedEventSubscription_ChannelDeleted_Fragment | OrderConfirmedEventSubscription_ChannelMetadataUpdated_Fragment | OrderConfirmedEventSubscription_ChannelStatusChanged_Fragment | OrderConfirmedEventSubscription_ChannelUpdated_Fragment | OrderConfirmedEventSubscription_CheckoutCreated_Fragment | OrderConfirmedEventSubscription_CheckoutFilterShippingMethods_Fragment | OrderConfirmedEventSubscription_CheckoutFullyPaid_Fragment | OrderConfirmedEventSubscription_CheckoutMetadataUpdated_Fragment | OrderConfirmedEventSubscription_CheckoutUpdated_Fragment | OrderConfirmedEventSubscription_CollectionCreated_Fragment | OrderConfirmedEventSubscription_CollectionDeleted_Fragment | OrderConfirmedEventSubscription_CollectionMetadataUpdated_Fragment | OrderConfirmedEventSubscription_CollectionUpdated_Fragment | OrderConfirmedEventSubscription_CustomerCreated_Fragment | OrderConfirmedEventSubscription_CustomerMetadataUpdated_Fragment | OrderConfirmedEventSubscription_CustomerUpdated_Fragment | OrderConfirmedEventSubscription_DraftOrderCreated_Fragment | OrderConfirmedEventSubscription_DraftOrderDeleted_Fragment | OrderConfirmedEventSubscription_DraftOrderUpdated_Fragment | OrderConfirmedEventSubscription_FulfillmentApproved_Fragment | OrderConfirmedEventSubscription_FulfillmentCanceled_Fragment | OrderConfirmedEventSubscription_FulfillmentCreated_Fragment | OrderConfirmedEventSubscription_FulfillmentMetadataUpdated_Fragment | OrderConfirmedEventSubscription_FulfillmentTrackingNumberUpdated_Fragment | OrderConfirmedEventSubscription_GiftCardCreated_Fragment | OrderConfirmedEventSubscription_GiftCardDeleted_Fragment | OrderConfirmedEventSubscription_GiftCardExportCompleted_Fragment | OrderConfirmedEventSubscription_GiftCardMetadataUpdated_Fragment | OrderConfirmedEventSubscription_GiftCardSent_Fragment | OrderConfirmedEventSubscription_GiftCardStatusChanged_Fragment | OrderConfirmedEventSubscription_GiftCardUpdated_Fragment | OrderConfirmedEventSubscription_InvoiceDeleted_Fragment | OrderConfirmedEventSubscription_InvoiceRequested_Fragment | OrderConfirmedEventSubscription_InvoiceSent_Fragment | OrderConfirmedEventSubscription_ListStoredPaymentMethods_Fragment | OrderConfirmedEventSubscription_MenuCreated_Fragment | OrderConfirmedEventSubscription_MenuDeleted_Fragment | OrderConfirmedEventSubscription_MenuItemCreated_Fragment | OrderConfirmedEventSubscription_MenuItemDeleted_Fragment | OrderConfirmedEventSubscription_MenuItemUpdated_Fragment | OrderConfirmedEventSubscription_MenuUpdated_Fragment | OrderConfirmedEventSubscription_OrderBulkCreated_Fragment | OrderConfirmedEventSubscription_OrderCancelled_Fragment | OrderConfirmedEventSubscription_OrderConfirmed_Fragment | OrderConfirmedEventSubscription_OrderCreated_Fragment | OrderConfirmedEventSubscription_OrderExpired_Fragment | OrderConfirmedEventSubscription_OrderFilterShippingMethods_Fragment | OrderConfirmedEventSubscription_OrderFulfilled_Fragment | OrderConfirmedEventSubscription_OrderFullyPaid_Fragment | OrderConfirmedEventSubscription_OrderFullyRefunded_Fragment | OrderConfirmedEventSubscription_OrderMetadataUpdated_Fragment | OrderConfirmedEventSubscription_OrderPaid_Fragment | OrderConfirmedEventSubscription_OrderRefunded_Fragment | OrderConfirmedEventSubscription_OrderUpdated_Fragment | OrderConfirmedEventSubscription_PageCreated_Fragment | OrderConfirmedEventSubscription_PageDeleted_Fragment | OrderConfirmedEventSubscription_PageTypeCreated_Fragment | OrderConfirmedEventSubscription_PageTypeDeleted_Fragment | OrderConfirmedEventSubscription_PageTypeUpdated_Fragment | OrderConfirmedEventSubscription_PageUpdated_Fragment | OrderConfirmedEventSubscription_PaymentAuthorize_Fragment | OrderConfirmedEventSubscription_PaymentCaptureEvent_Fragment | OrderConfirmedEventSubscription_PaymentConfirmEvent_Fragment | OrderConfirmedEventSubscription_PaymentGatewayInitializeSession_Fragment | OrderConfirmedEventSubscription_PaymentGatewayInitializeTokenizationSession_Fragment | OrderConfirmedEventSubscription_PaymentListGateways_Fragment | OrderConfirmedEventSubscription_PaymentMethodInitializeTokenizationSession_Fragment | OrderConfirmedEventSubscription_PaymentMethodProcessTokenizationSession_Fragment | OrderConfirmedEventSubscription_PaymentProcessEvent_Fragment | OrderConfirmedEventSubscription_PaymentRefundEvent_Fragment | OrderConfirmedEventSubscription_PaymentVoidEvent_Fragment | OrderConfirmedEventSubscription_PermissionGroupCreated_Fragment | OrderConfirmedEventSubscription_PermissionGroupDeleted_Fragment | OrderConfirmedEventSubscription_PermissionGroupUpdated_Fragment | OrderConfirmedEventSubscription_ProductCreated_Fragment | OrderConfirmedEventSubscription_ProductDeleted_Fragment | OrderConfirmedEventSubscription_ProductExportCompleted_Fragment | OrderConfirmedEventSubscription_ProductMediaCreated_Fragment | OrderConfirmedEventSubscription_ProductMediaDeleted_Fragment | OrderConfirmedEventSubscription_ProductMediaUpdated_Fragment | OrderConfirmedEventSubscription_ProductMetadataUpdated_Fragment | OrderConfirmedEventSubscription_ProductUpdated_Fragment | OrderConfirmedEventSubscription_ProductVariantBackInStock_Fragment | OrderConfirmedEventSubscription_ProductVariantCreated_Fragment | OrderConfirmedEventSubscription_ProductVariantDeleted_Fragment | OrderConfirmedEventSubscription_ProductVariantMetadataUpdated_Fragment | OrderConfirmedEventSubscription_ProductVariantOutOfStock_Fragment | OrderConfirmedEventSubscription_ProductVariantStockUpdated_Fragment | OrderConfirmedEventSubscription_ProductVariantUpdated_Fragment | OrderConfirmedEventSubscription_PromotionCreated_Fragment | OrderConfirmedEventSubscription_PromotionDeleted_Fragment | OrderConfirmedEventSubscription_PromotionEnded_Fragment | OrderConfirmedEventSubscription_PromotionRuleCreated_Fragment | OrderConfirmedEventSubscription_PromotionRuleDeleted_Fragment | OrderConfirmedEventSubscription_PromotionRuleUpdated_Fragment | OrderConfirmedEventSubscription_PromotionStarted_Fragment | OrderConfirmedEventSubscription_PromotionUpdated_Fragment | OrderConfirmedEventSubscription_SaleCreated_Fragment | OrderConfirmedEventSubscription_SaleDeleted_Fragment | OrderConfirmedEventSubscription_SaleToggle_Fragment | OrderConfirmedEventSubscription_SaleUpdated_Fragment | OrderConfirmedEventSubscription_ShippingListMethodsForCheckout_Fragment | OrderConfirmedEventSubscription_ShippingPriceCreated_Fragment | OrderConfirmedEventSubscription_ShippingPriceDeleted_Fragment | OrderConfirmedEventSubscription_ShippingPriceUpdated_Fragment | OrderConfirmedEventSubscription_ShippingZoneCreated_Fragment | OrderConfirmedEventSubscription_ShippingZoneDeleted_Fragment | OrderConfirmedEventSubscription_ShippingZoneMetadataUpdated_Fragment | OrderConfirmedEventSubscription_ShippingZoneUpdated_Fragment | OrderConfirmedEventSubscription_ShopMetadataUpdated_Fragment | OrderConfirmedEventSubscription_StaffCreated_Fragment | OrderConfirmedEventSubscription_StaffDeleted_Fragment | OrderConfirmedEventSubscription_StaffSetPasswordRequested_Fragment | OrderConfirmedEventSubscription_StaffUpdated_Fragment | OrderConfirmedEventSubscription_StoredPaymentMethodDeleteRequested_Fragment | OrderConfirmedEventSubscription_ThumbnailCreated_Fragment | OrderConfirmedEventSubscription_TransactionCancelationRequested_Fragment | OrderConfirmedEventSubscription_TransactionChargeRequested_Fragment | OrderConfirmedEventSubscription_TransactionInitializeSession_Fragment | OrderConfirmedEventSubscription_TransactionItemMetadataUpdated_Fragment | OrderConfirmedEventSubscription_TransactionProcessSession_Fragment | OrderConfirmedEventSubscription_TransactionRefundRequested_Fragment | OrderConfirmedEventSubscription_TranslationCreated_Fragment | OrderConfirmedEventSubscription_TranslationUpdated_Fragment | OrderConfirmedEventSubscription_VoucherCodeExportCompleted_Fragment | OrderConfirmedEventSubscription_VoucherCodesCreated_Fragment | OrderConfirmedEventSubscription_VoucherCodesDeleted_Fragment | OrderConfirmedEventSubscription_VoucherCreated_Fragment | OrderConfirmedEventSubscription_VoucherDeleted_Fragment | OrderConfirmedEventSubscription_VoucherMetadataUpdated_Fragment | OrderConfirmedEventSubscription_VoucherUpdated_Fragment | OrderConfirmedEventSubscription_WarehouseCreated_Fragment | OrderConfirmedEventSubscription_WarehouseDeleted_Fragment | OrderConfirmedEventSubscription_WarehouseMetadataUpdated_Fragment | OrderConfirmedEventSubscription_WarehouseUpdated_Fragment; +export type OrderConfirmedEventSubscriptionFragment = OrderConfirmedEventSubscription_AccountChangeEmailRequested_Fragment | OrderConfirmedEventSubscription_AccountConfirmationRequested_Fragment | OrderConfirmedEventSubscription_AccountConfirmed_Fragment | OrderConfirmedEventSubscription_AccountDeleteRequested_Fragment | OrderConfirmedEventSubscription_AccountDeleted_Fragment | OrderConfirmedEventSubscription_AccountEmailChanged_Fragment | OrderConfirmedEventSubscription_AccountSetPasswordRequested_Fragment | OrderConfirmedEventSubscription_AddressCreated_Fragment | OrderConfirmedEventSubscription_AddressDeleted_Fragment | OrderConfirmedEventSubscription_AddressUpdated_Fragment | OrderConfirmedEventSubscription_AppDeleted_Fragment | OrderConfirmedEventSubscription_AppInstalled_Fragment | OrderConfirmedEventSubscription_AppStatusChanged_Fragment | OrderConfirmedEventSubscription_AppUpdated_Fragment | OrderConfirmedEventSubscription_AttributeCreated_Fragment | OrderConfirmedEventSubscription_AttributeDeleted_Fragment | OrderConfirmedEventSubscription_AttributeUpdated_Fragment | OrderConfirmedEventSubscription_AttributeValueCreated_Fragment | OrderConfirmedEventSubscription_AttributeValueDeleted_Fragment | OrderConfirmedEventSubscription_AttributeValueUpdated_Fragment | OrderConfirmedEventSubscription_CalculateTaxes_Fragment | OrderConfirmedEventSubscription_CategoryCreated_Fragment | OrderConfirmedEventSubscription_CategoryDeleted_Fragment | OrderConfirmedEventSubscription_CategoryUpdated_Fragment | OrderConfirmedEventSubscription_ChannelCreated_Fragment | OrderConfirmedEventSubscription_ChannelDeleted_Fragment | OrderConfirmedEventSubscription_ChannelMetadataUpdated_Fragment | OrderConfirmedEventSubscription_ChannelStatusChanged_Fragment | OrderConfirmedEventSubscription_ChannelUpdated_Fragment | OrderConfirmedEventSubscription_CheckoutCreated_Fragment | OrderConfirmedEventSubscription_CheckoutFilterShippingMethods_Fragment | OrderConfirmedEventSubscription_CheckoutFullyAuthorized_Fragment | OrderConfirmedEventSubscription_CheckoutFullyPaid_Fragment | OrderConfirmedEventSubscription_CheckoutMetadataUpdated_Fragment | OrderConfirmedEventSubscription_CheckoutUpdated_Fragment | OrderConfirmedEventSubscription_CollectionCreated_Fragment | OrderConfirmedEventSubscription_CollectionDeleted_Fragment | OrderConfirmedEventSubscription_CollectionMetadataUpdated_Fragment | OrderConfirmedEventSubscription_CollectionUpdated_Fragment | OrderConfirmedEventSubscription_CustomerCreated_Fragment | OrderConfirmedEventSubscription_CustomerMetadataUpdated_Fragment | OrderConfirmedEventSubscription_CustomerUpdated_Fragment | OrderConfirmedEventSubscription_DraftOrderCreated_Fragment | OrderConfirmedEventSubscription_DraftOrderDeleted_Fragment | OrderConfirmedEventSubscription_DraftOrderUpdated_Fragment | OrderConfirmedEventSubscription_FulfillmentApproved_Fragment | OrderConfirmedEventSubscription_FulfillmentCanceled_Fragment | OrderConfirmedEventSubscription_FulfillmentCreated_Fragment | OrderConfirmedEventSubscription_FulfillmentMetadataUpdated_Fragment | OrderConfirmedEventSubscription_FulfillmentTrackingNumberUpdated_Fragment | OrderConfirmedEventSubscription_GiftCardCreated_Fragment | OrderConfirmedEventSubscription_GiftCardDeleted_Fragment | OrderConfirmedEventSubscription_GiftCardExportCompleted_Fragment | OrderConfirmedEventSubscription_GiftCardMetadataUpdated_Fragment | OrderConfirmedEventSubscription_GiftCardSent_Fragment | OrderConfirmedEventSubscription_GiftCardStatusChanged_Fragment | OrderConfirmedEventSubscription_GiftCardUpdated_Fragment | OrderConfirmedEventSubscription_InvoiceDeleted_Fragment | OrderConfirmedEventSubscription_InvoiceRequested_Fragment | OrderConfirmedEventSubscription_InvoiceSent_Fragment | OrderConfirmedEventSubscription_ListStoredPaymentMethods_Fragment | OrderConfirmedEventSubscription_MenuCreated_Fragment | OrderConfirmedEventSubscription_MenuDeleted_Fragment | OrderConfirmedEventSubscription_MenuItemCreated_Fragment | OrderConfirmedEventSubscription_MenuItemDeleted_Fragment | OrderConfirmedEventSubscription_MenuItemUpdated_Fragment | OrderConfirmedEventSubscription_MenuUpdated_Fragment | OrderConfirmedEventSubscription_OrderBulkCreated_Fragment | OrderConfirmedEventSubscription_OrderCancelled_Fragment | OrderConfirmedEventSubscription_OrderConfirmed_Fragment | OrderConfirmedEventSubscription_OrderCreated_Fragment | OrderConfirmedEventSubscription_OrderExpired_Fragment | OrderConfirmedEventSubscription_OrderFilterShippingMethods_Fragment | OrderConfirmedEventSubscription_OrderFulfilled_Fragment | OrderConfirmedEventSubscription_OrderFullyPaid_Fragment | OrderConfirmedEventSubscription_OrderFullyRefunded_Fragment | OrderConfirmedEventSubscription_OrderMetadataUpdated_Fragment | OrderConfirmedEventSubscription_OrderPaid_Fragment | OrderConfirmedEventSubscription_OrderRefunded_Fragment | OrderConfirmedEventSubscription_OrderUpdated_Fragment | OrderConfirmedEventSubscription_PageCreated_Fragment | OrderConfirmedEventSubscription_PageDeleted_Fragment | OrderConfirmedEventSubscription_PageTypeCreated_Fragment | OrderConfirmedEventSubscription_PageTypeDeleted_Fragment | OrderConfirmedEventSubscription_PageTypeUpdated_Fragment | OrderConfirmedEventSubscription_PageUpdated_Fragment | OrderConfirmedEventSubscription_PaymentAuthorize_Fragment | OrderConfirmedEventSubscription_PaymentCaptureEvent_Fragment | OrderConfirmedEventSubscription_PaymentConfirmEvent_Fragment | OrderConfirmedEventSubscription_PaymentGatewayInitializeSession_Fragment | OrderConfirmedEventSubscription_PaymentGatewayInitializeTokenizationSession_Fragment | OrderConfirmedEventSubscription_PaymentListGateways_Fragment | OrderConfirmedEventSubscription_PaymentMethodInitializeTokenizationSession_Fragment | OrderConfirmedEventSubscription_PaymentMethodProcessTokenizationSession_Fragment | OrderConfirmedEventSubscription_PaymentProcessEvent_Fragment | OrderConfirmedEventSubscription_PaymentRefundEvent_Fragment | OrderConfirmedEventSubscription_PaymentVoidEvent_Fragment | OrderConfirmedEventSubscription_PermissionGroupCreated_Fragment | OrderConfirmedEventSubscription_PermissionGroupDeleted_Fragment | OrderConfirmedEventSubscription_PermissionGroupUpdated_Fragment | OrderConfirmedEventSubscription_ProductCreated_Fragment | OrderConfirmedEventSubscription_ProductDeleted_Fragment | OrderConfirmedEventSubscription_ProductExportCompleted_Fragment | OrderConfirmedEventSubscription_ProductMediaCreated_Fragment | OrderConfirmedEventSubscription_ProductMediaDeleted_Fragment | OrderConfirmedEventSubscription_ProductMediaUpdated_Fragment | OrderConfirmedEventSubscription_ProductMetadataUpdated_Fragment | OrderConfirmedEventSubscription_ProductUpdated_Fragment | OrderConfirmedEventSubscription_ProductVariantBackInStock_Fragment | OrderConfirmedEventSubscription_ProductVariantCreated_Fragment | OrderConfirmedEventSubscription_ProductVariantDeleted_Fragment | OrderConfirmedEventSubscription_ProductVariantMetadataUpdated_Fragment | OrderConfirmedEventSubscription_ProductVariantOutOfStock_Fragment | OrderConfirmedEventSubscription_ProductVariantStockUpdated_Fragment | OrderConfirmedEventSubscription_ProductVariantUpdated_Fragment | OrderConfirmedEventSubscription_PromotionCreated_Fragment | OrderConfirmedEventSubscription_PromotionDeleted_Fragment | OrderConfirmedEventSubscription_PromotionEnded_Fragment | OrderConfirmedEventSubscription_PromotionRuleCreated_Fragment | OrderConfirmedEventSubscription_PromotionRuleDeleted_Fragment | OrderConfirmedEventSubscription_PromotionRuleUpdated_Fragment | OrderConfirmedEventSubscription_PromotionStarted_Fragment | OrderConfirmedEventSubscription_PromotionUpdated_Fragment | OrderConfirmedEventSubscription_SaleCreated_Fragment | OrderConfirmedEventSubscription_SaleDeleted_Fragment | OrderConfirmedEventSubscription_SaleToggle_Fragment | OrderConfirmedEventSubscription_SaleUpdated_Fragment | OrderConfirmedEventSubscription_ShippingListMethodsForCheckout_Fragment | OrderConfirmedEventSubscription_ShippingPriceCreated_Fragment | OrderConfirmedEventSubscription_ShippingPriceDeleted_Fragment | OrderConfirmedEventSubscription_ShippingPriceUpdated_Fragment | OrderConfirmedEventSubscription_ShippingZoneCreated_Fragment | OrderConfirmedEventSubscription_ShippingZoneDeleted_Fragment | OrderConfirmedEventSubscription_ShippingZoneMetadataUpdated_Fragment | OrderConfirmedEventSubscription_ShippingZoneUpdated_Fragment | OrderConfirmedEventSubscription_ShopMetadataUpdated_Fragment | OrderConfirmedEventSubscription_StaffCreated_Fragment | OrderConfirmedEventSubscription_StaffDeleted_Fragment | OrderConfirmedEventSubscription_StaffSetPasswordRequested_Fragment | OrderConfirmedEventSubscription_StaffUpdated_Fragment | OrderConfirmedEventSubscription_StoredPaymentMethodDeleteRequested_Fragment | OrderConfirmedEventSubscription_ThumbnailCreated_Fragment | OrderConfirmedEventSubscription_TransactionCancelationRequested_Fragment | OrderConfirmedEventSubscription_TransactionChargeRequested_Fragment | OrderConfirmedEventSubscription_TransactionInitializeSession_Fragment | OrderConfirmedEventSubscription_TransactionItemMetadataUpdated_Fragment | OrderConfirmedEventSubscription_TransactionProcessSession_Fragment | OrderConfirmedEventSubscription_TransactionRefundRequested_Fragment | OrderConfirmedEventSubscription_TranslationCreated_Fragment | OrderConfirmedEventSubscription_TranslationUpdated_Fragment | OrderConfirmedEventSubscription_VoucherCodeExportCompleted_Fragment | OrderConfirmedEventSubscription_VoucherCodesCreated_Fragment | OrderConfirmedEventSubscription_VoucherCodesDeleted_Fragment | OrderConfirmedEventSubscription_VoucherCreated_Fragment | OrderConfirmedEventSubscription_VoucherDeleted_Fragment | OrderConfirmedEventSubscription_VoucherMetadataUpdated_Fragment | OrderConfirmedEventSubscription_VoucherUpdated_Fragment | OrderConfirmedEventSubscription_WarehouseCreated_Fragment | OrderConfirmedEventSubscription_WarehouseDeleted_Fragment | OrderConfirmedEventSubscription_WarehouseMetadataUpdated_Fragment | OrderConfirmedEventSubscription_WarehouseUpdated_Fragment; export type OrderConfirmedSubscriptionSubscriptionVariables = Exact<{ [key: string]: never; }>; -export type OrderConfirmedSubscriptionSubscription = { __typename?: 'Subscription', event?: { __typename: 'AccountChangeEmailRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AccountConfirmationRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AccountConfirmed', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AccountDeleteRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AccountDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AccountEmailChanged', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AccountSetPasswordRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AddressCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AddressDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AddressUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AppDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AppInstalled', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AppStatusChanged', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AppUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AttributeCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AttributeDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AttributeUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AttributeValueCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AttributeValueDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AttributeValueUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CalculateTaxes', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CategoryCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CategoryDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CategoryUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ChannelCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ChannelDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ChannelMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ChannelStatusChanged', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ChannelUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CheckoutCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CheckoutFilterShippingMethods', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CheckoutFullyPaid', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CheckoutMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CheckoutUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CollectionCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CollectionDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CollectionMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CollectionUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CustomerCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CustomerMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CustomerUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'DraftOrderCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'DraftOrderDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'DraftOrderUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'FulfillmentApproved', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'FulfillmentCanceled', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'FulfillmentCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'FulfillmentMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'FulfillmentTrackingNumberUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'GiftCardCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'GiftCardDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'GiftCardExportCompleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'GiftCardMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'GiftCardSent', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'GiftCardStatusChanged', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'GiftCardUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'InvoiceDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'InvoiceRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'InvoiceSent', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ListStoredPaymentMethods', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'MenuCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'MenuDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'MenuItemCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'MenuItemDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'MenuItemUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'MenuUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderBulkCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderCancelled', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderConfirmed', issuedAt?: string | null, version?: string | null, order?: { __typename?: 'Order', id: string, number: string, userEmail?: string | null, created: string, status: OrderStatus, avataxCustomerCode?: string | null, avataxEntityCode?: string | null, avataxTaxCalculationDate?: string | null, avataxDocumentCode?: string | null, user?: { __typename?: 'User', id: string, email: string, avataxCustomerCode?: string | null } | null, channel: { __typename?: 'Channel', id: string, slug: string, taxConfiguration: { __typename?: 'TaxConfiguration', pricesEnteredWithTax: boolean, taxCalculationStrategy?: TaxCalculationStrategy | null } }, shippingAddress?: { __typename?: 'Address', streetAddress1: string, streetAddress2: string, city: string, countryArea: string, postalCode: string, country: { __typename?: 'CountryDisplay', code: string } } | null, billingAddress?: { __typename?: 'Address', streetAddress1: string, streetAddress2: string, city: string, countryArea: string, postalCode: string, country: { __typename?: 'CountryDisplay', code: string } } | null, total: { __typename?: 'TaxedMoney', currency: string, net: { __typename?: 'Money', amount: number }, tax: { __typename?: 'Money', amount: number } }, shippingPrice: { __typename?: 'TaxedMoney', gross: { __typename?: 'Money', amount: number }, net: { __typename?: 'Money', amount: number } }, lines: Array<{ __typename?: 'OrderLine', productSku?: string | null, productVariantId?: string | null, productName: string, quantity: number, taxClass?: { __typename?: 'TaxClass', id: string } | null, unitPrice: { __typename?: 'TaxedMoney', net: { __typename?: 'Money', amount: number } }, totalPrice: { __typename?: 'TaxedMoney', net: { __typename?: 'Money', amount: number }, tax: { __typename?: 'Money', amount: number }, gross: { __typename?: 'Money', amount: number } } }> } | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderExpired', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderFilterShippingMethods', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderFulfilled', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderFullyPaid', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderFullyRefunded', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderPaid', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderRefunded', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PageCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PageDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PageTypeCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PageTypeDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PageTypeUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PageUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentAuthorize', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentCaptureEvent', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentConfirmEvent', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentGatewayInitializeSession', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentGatewayInitializeTokenizationSession', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentListGateways', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentMethodInitializeTokenizationSession', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentMethodProcessTokenizationSession', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentProcessEvent', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentRefundEvent', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentVoidEvent', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PermissionGroupCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PermissionGroupDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PermissionGroupUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductExportCompleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductMediaCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductMediaDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductMediaUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductVariantBackInStock', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductVariantCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductVariantDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductVariantMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductVariantOutOfStock', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductVariantStockUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductVariantUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PromotionCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PromotionDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PromotionEnded', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PromotionRuleCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PromotionRuleDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PromotionRuleUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PromotionStarted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PromotionUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'SaleCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'SaleDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'SaleToggle', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'SaleUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ShippingListMethodsForCheckout', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ShippingPriceCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ShippingPriceDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ShippingPriceUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ShippingZoneCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ShippingZoneDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ShippingZoneMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ShippingZoneUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ShopMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'StaffCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'StaffDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'StaffSetPasswordRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'StaffUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'StoredPaymentMethodDeleteRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ThumbnailCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'TransactionCancelationRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'TransactionChargeRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'TransactionInitializeSession', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'TransactionItemMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'TransactionProcessSession', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'TransactionRefundRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'TranslationCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'TranslationUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'VoucherCodeExportCompleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'VoucherCodesCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'VoucherCodesDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'VoucherCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'VoucherDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'VoucherMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'VoucherUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'WarehouseCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'WarehouseDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'WarehouseMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'WarehouseUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | null }; +export type OrderConfirmedSubscriptionSubscription = { __typename?: 'Subscription', event?: { __typename: 'AccountChangeEmailRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AccountConfirmationRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AccountConfirmed', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AccountDeleteRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AccountDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AccountEmailChanged', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AccountSetPasswordRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AddressCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AddressDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AddressUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AppDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AppInstalled', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AppStatusChanged', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AppUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AttributeCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AttributeDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AttributeUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AttributeValueCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AttributeValueDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'AttributeValueUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CalculateTaxes', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CategoryCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CategoryDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CategoryUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ChannelCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ChannelDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ChannelMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ChannelStatusChanged', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ChannelUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CheckoutCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CheckoutFilterShippingMethods', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CheckoutFullyAuthorized', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CheckoutFullyPaid', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CheckoutMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CheckoutUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CollectionCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CollectionDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CollectionMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CollectionUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CustomerCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CustomerMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'CustomerUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'DraftOrderCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'DraftOrderDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'DraftOrderUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'FulfillmentApproved', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'FulfillmentCanceled', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'FulfillmentCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'FulfillmentMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'FulfillmentTrackingNumberUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'GiftCardCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'GiftCardDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'GiftCardExportCompleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'GiftCardMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'GiftCardSent', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'GiftCardStatusChanged', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'GiftCardUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'InvoiceDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'InvoiceRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'InvoiceSent', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ListStoredPaymentMethods', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'MenuCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'MenuDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'MenuItemCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'MenuItemDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'MenuItemUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'MenuUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderBulkCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderCancelled', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderConfirmed', issuedAt?: string | null, version?: string | null, order?: { __typename?: 'Order', id: string, number: string, userEmail?: string | null, created: string, status: OrderStatus, avataxCustomerCode?: string | null, avataxEntityCode?: string | null, avataxTaxCalculationDate?: string | null, avataxDocumentCode?: string | null, user?: { __typename?: 'User', id: string, email: string, avataxCustomerCode?: string | null } | null, channel: { __typename?: 'Channel', id: string, slug: string, taxConfiguration: { __typename?: 'TaxConfiguration', pricesEnteredWithTax: boolean, taxCalculationStrategy?: TaxCalculationStrategy | null } }, shippingAddress?: { __typename?: 'Address', streetAddress1: string, streetAddress2: string, city: string, countryArea: string, postalCode: string, country: { __typename?: 'CountryDisplay', code: string } } | null, billingAddress?: { __typename?: 'Address', streetAddress1: string, streetAddress2: string, city: string, countryArea: string, postalCode: string, country: { __typename?: 'CountryDisplay', code: string } } | null, total: { __typename?: 'TaxedMoney', currency: string, net: { __typename?: 'Money', amount: number }, tax: { __typename?: 'Money', amount: number } }, shippingPrice: { __typename?: 'TaxedMoney', gross: { __typename?: 'Money', amount: number }, net: { __typename?: 'Money', amount: number } }, lines: Array<{ __typename?: 'OrderLine', productSku?: string | null, productVariantId?: string | null, productName: string, quantity: number, taxClass?: { __typename?: 'TaxClass', id: string } | null, unitPrice: { __typename?: 'TaxedMoney', net: { __typename?: 'Money', amount: number } }, totalPrice: { __typename?: 'TaxedMoney', net: { __typename?: 'Money', amount: number }, tax: { __typename?: 'Money', amount: number }, gross: { __typename?: 'Money', amount: number } } }> } | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderExpired', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderFilterShippingMethods', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderFulfilled', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderFullyPaid', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderFullyRefunded', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderPaid', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderRefunded', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'OrderUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PageCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PageDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PageTypeCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PageTypeDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PageTypeUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PageUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentAuthorize', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentCaptureEvent', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentConfirmEvent', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentGatewayInitializeSession', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentGatewayInitializeTokenizationSession', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentListGateways', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentMethodInitializeTokenizationSession', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentMethodProcessTokenizationSession', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentProcessEvent', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentRefundEvent', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PaymentVoidEvent', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PermissionGroupCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PermissionGroupDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PermissionGroupUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductExportCompleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductMediaCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductMediaDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductMediaUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductVariantBackInStock', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductVariantCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductVariantDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductVariantMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductVariantOutOfStock', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductVariantStockUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ProductVariantUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PromotionCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PromotionDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PromotionEnded', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PromotionRuleCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PromotionRuleDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PromotionRuleUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PromotionStarted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'PromotionUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'SaleCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'SaleDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'SaleToggle', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'SaleUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ShippingListMethodsForCheckout', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ShippingPriceCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ShippingPriceDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ShippingPriceUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ShippingZoneCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ShippingZoneDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ShippingZoneMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ShippingZoneUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ShopMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'StaffCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'StaffDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'StaffSetPasswordRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'StaffUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'StoredPaymentMethodDeleteRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'ThumbnailCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'TransactionCancelationRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'TransactionChargeRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'TransactionInitializeSession', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'TransactionItemMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'TransactionProcessSession', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'TransactionRefundRequested', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'TranslationCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'TranslationUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'VoucherCodeExportCompleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'VoucherCodesCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'VoucherCodesDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'VoucherCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'VoucherDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'VoucherMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'VoucherUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'WarehouseCreated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'WarehouseDeleted', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'WarehouseMetadataUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | { __typename: 'WarehouseUpdated', issuedAt?: string | null, version?: string | null, recipient?: { __typename?: 'App', privateMetadata: Array<{ __typename?: 'MetadataItem', key: string, value: string }> } | null } | null }; -export const UntypedWebhookMetadataFragmentDoc = gql` - fragment WebhookMetadata on Event { - issuedAt - version -} - `; export const UntypedTaxDiscountFragmentDoc = gql` fragment TaxDiscount on TaxableObjectDiscount { amount { @@ -34713,20 +32753,19 @@ export const UntypedTaxBaseFragmentDoc = gql` } `; export const UntypedCalculateTaxesEventFragmentDoc = gql` - fragment CalculateTaxesEvent on Event { - __typename - ...WebhookMetadata - ... on CalculateTaxes { - taxBase { - ...TaxBase - } - recipient { - privateMetadata { - key - value - } + fragment CalculateTaxesEvent on CalculateTaxes { + taxBase { + ...TaxBase + } + recipient { + privateMetadata { + key + value } } + __typename + issuedAt + version } `; export const UntypedTaxClassFragmentDoc = gql` @@ -34778,6 +32817,12 @@ export const UntypedTaxConfigurationFragmentDoc = gql` __typename } `; +export const UntypedWebhookMetadataFragmentDoc = gql` + fragment WebhookMetadata on Event { + issuedAt + version +} + `; export const UntypedOrderCancelledSubscriptionFragmentDoc = gql` fragment OrderCancelledSubscription on Order { id @@ -35068,13 +33113,19 @@ ${UntypedTaxConfigurationPerCountryFragmentDoc} ${UntypedCountryWithCodeFragmentDoc}`; export const UntypedCalculateTaxesDocument = gql` subscription CalculateTaxes { - event { - ...CalculateTaxesEvent + calculateTaxes(deferIf: ADDRESS_MISSING) { + taxBase { + ...TaxBase + } + recipient { + privateMetadata { + key + value + } + } } } - ${UntypedCalculateTaxesEventFragmentDoc} -${UntypedWebhookMetadataFragmentDoc} -${UntypedTaxBaseFragmentDoc} + ${UntypedTaxBaseFragmentDoc} ${UntypedTaxDiscountFragmentDoc} ${UntypedAddressFragmentDoc} ${UntypedTaxBaseLineFragmentDoc} @@ -35100,18 +33151,18 @@ ${UntypedOrderConfirmedSubscriptionFragmentDoc} ${UntypedUserFragmentDoc} ${UntypedAddressFragmentDoc} ${UntypedOrderLineFragmentDoc}`; -export const WebhookMetadataFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"WebhookMetadata"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Event"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"issuedAt"}},{"kind":"Field","name":{"kind":"Name","value":"version"}}]}}]} as unknown as DocumentNode; export const TaxDiscountFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxDiscount"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxableObjectDiscount"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"type"}}]}}]} as unknown as DocumentNode; export const AddressFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"Address"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Address"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"streetAddress1"}},{"kind":"Field","name":{"kind":"Name","value":"streetAddress2"}},{"kind":"Field","name":{"kind":"Name","value":"city"}},{"kind":"Field","name":{"kind":"Name","value":"countryArea"}},{"kind":"Field","name":{"kind":"Name","value":"postalCode"}},{"kind":"Field","name":{"kind":"Name","value":"country"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"code"}}]}}]}}]} as unknown as DocumentNode; export const TaxBaseLineFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxBaseLine"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxableObjectLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"sourceLine"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"__typename"}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"CheckoutLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"checkoutProductVariant"},"name":{"kind":"Name","value":"variant"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"sku"}},{"kind":"Field","name":{"kind":"Name","value":"product"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"taxClass"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}}]}}]}}]}}]}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"OrderLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"orderProductVariant"},"name":{"kind":"Name","value":"variant"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"sku"}},{"kind":"Field","name":{"kind":"Name","value":"product"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"taxClass"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}}]}}]}}]}}]}}]}},{"kind":"Field","name":{"kind":"Name","value":"quantity"}},{"kind":"Field","name":{"kind":"Name","value":"unitPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"totalPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}}]}}]} as unknown as DocumentNode; export const UserFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"User"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"User"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"email"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxCustomerCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxCustomerCode","block":false}}]}]}}]} as unknown as DocumentNode; export const TaxBaseFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxBase"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxableObject"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"pricesEnteredWithTax"}},{"kind":"Field","name":{"kind":"Name","value":"currency"}},{"kind":"Field","name":{"kind":"Name","value":"channel"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"slug"}},{"kind":"Field","name":{"kind":"Name","value":"id"}}]}},{"kind":"Field","name":{"kind":"Name","value":"discounts"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"TaxDiscount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"address"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"Address"}}]}},{"kind":"Field","name":{"kind":"Name","value":"shippingPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"lines"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"TaxBaseLine"}}]}},{"kind":"Field","name":{"kind":"Name","value":"sourceObject"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"__typename"}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Checkout"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxEntityCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxEntityCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxCustomerCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxCustomerCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxExemptionStatus"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxExemptionStatus","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxShipFromAddress"},"name":{"kind":"Name","value":"privateMetafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxShipFromAddress","block":false}}]},{"kind":"Field","name":{"kind":"Name","value":"user"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"User"}}]}}]}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Order"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxEntityCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxEntityCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxCustomerCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxCustomerCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxExemptionStatus"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxExemptionStatus","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxShipFromAddress"},"name":{"kind":"Name","value":"privateMetafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxShipFromAddress","block":false}}]},{"kind":"Field","name":{"kind":"Name","value":"user"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"User"}}]}}]}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxDiscount"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxableObjectDiscount"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"type"}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"Address"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Address"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"streetAddress1"}},{"kind":"Field","name":{"kind":"Name","value":"streetAddress2"}},{"kind":"Field","name":{"kind":"Name","value":"city"}},{"kind":"Field","name":{"kind":"Name","value":"countryArea"}},{"kind":"Field","name":{"kind":"Name","value":"postalCode"}},{"kind":"Field","name":{"kind":"Name","value":"country"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"code"}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxBaseLine"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxableObjectLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"sourceLine"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"__typename"}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"CheckoutLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"checkoutProductVariant"},"name":{"kind":"Name","value":"variant"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"sku"}},{"kind":"Field","name":{"kind":"Name","value":"product"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"taxClass"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}}]}}]}}]}}]}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"OrderLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"orderProductVariant"},"name":{"kind":"Name","value":"variant"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"sku"}},{"kind":"Field","name":{"kind":"Name","value":"product"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"taxClass"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}}]}}]}}]}}]}}]}},{"kind":"Field","name":{"kind":"Name","value":"quantity"}},{"kind":"Field","name":{"kind":"Name","value":"unitPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"totalPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"User"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"User"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"email"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxCustomerCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxCustomerCode","block":false}}]}]}}]} as unknown as DocumentNode; -export const CalculateTaxesEventFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"CalculateTaxesEvent"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Event"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"__typename"}},{"kind":"FragmentSpread","name":{"kind":"Name","value":"WebhookMetadata"}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"CalculateTaxes"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"taxBase"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"TaxBase"}}]}},{"kind":"Field","name":{"kind":"Name","value":"recipient"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"privateMetadata"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"key"}},{"kind":"Field","name":{"kind":"Name","value":"value"}}]}}]}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxDiscount"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxableObjectDiscount"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"type"}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"Address"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Address"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"streetAddress1"}},{"kind":"Field","name":{"kind":"Name","value":"streetAddress2"}},{"kind":"Field","name":{"kind":"Name","value":"city"}},{"kind":"Field","name":{"kind":"Name","value":"countryArea"}},{"kind":"Field","name":{"kind":"Name","value":"postalCode"}},{"kind":"Field","name":{"kind":"Name","value":"country"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"code"}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxBaseLine"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxableObjectLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"sourceLine"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"__typename"}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"CheckoutLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"checkoutProductVariant"},"name":{"kind":"Name","value":"variant"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"sku"}},{"kind":"Field","name":{"kind":"Name","value":"product"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"taxClass"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}}]}}]}}]}}]}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"OrderLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"orderProductVariant"},"name":{"kind":"Name","value":"variant"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"sku"}},{"kind":"Field","name":{"kind":"Name","value":"product"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"taxClass"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}}]}}]}}]}}]}}]}},{"kind":"Field","name":{"kind":"Name","value":"quantity"}},{"kind":"Field","name":{"kind":"Name","value":"unitPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"totalPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"User"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"User"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"email"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxCustomerCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxCustomerCode","block":false}}]}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"WebhookMetadata"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Event"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"issuedAt"}},{"kind":"Field","name":{"kind":"Name","value":"version"}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxBase"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxableObject"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"pricesEnteredWithTax"}},{"kind":"Field","name":{"kind":"Name","value":"currency"}},{"kind":"Field","name":{"kind":"Name","value":"channel"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"slug"}},{"kind":"Field","name":{"kind":"Name","value":"id"}}]}},{"kind":"Field","name":{"kind":"Name","value":"discounts"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"TaxDiscount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"address"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"Address"}}]}},{"kind":"Field","name":{"kind":"Name","value":"shippingPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"lines"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"TaxBaseLine"}}]}},{"kind":"Field","name":{"kind":"Name","value":"sourceObject"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"__typename"}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Checkout"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxEntityCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxEntityCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxCustomerCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxCustomerCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxExemptionStatus"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxExemptionStatus","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxShipFromAddress"},"name":{"kind":"Name","value":"privateMetafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxShipFromAddress","block":false}}]},{"kind":"Field","name":{"kind":"Name","value":"user"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"User"}}]}}]}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Order"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxEntityCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxEntityCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxCustomerCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxCustomerCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxExemptionStatus"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxExemptionStatus","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxShipFromAddress"},"name":{"kind":"Name","value":"privateMetafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxShipFromAddress","block":false}}]},{"kind":"Field","name":{"kind":"Name","value":"user"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"User"}}]}}]}}]}}]}}]} as unknown as DocumentNode; +export const CalculateTaxesEventFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"CalculateTaxesEvent"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"CalculateTaxes"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"taxBase"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"TaxBase"}}]}},{"kind":"Field","name":{"kind":"Name","value":"recipient"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"privateMetadata"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"key"}},{"kind":"Field","name":{"kind":"Name","value":"value"}}]}}]}},{"kind":"Field","name":{"kind":"Name","value":"__typename"}},{"kind":"Field","name":{"kind":"Name","value":"issuedAt"}},{"kind":"Field","name":{"kind":"Name","value":"version"}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxDiscount"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxableObjectDiscount"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"type"}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"Address"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Address"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"streetAddress1"}},{"kind":"Field","name":{"kind":"Name","value":"streetAddress2"}},{"kind":"Field","name":{"kind":"Name","value":"city"}},{"kind":"Field","name":{"kind":"Name","value":"countryArea"}},{"kind":"Field","name":{"kind":"Name","value":"postalCode"}},{"kind":"Field","name":{"kind":"Name","value":"country"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"code"}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxBaseLine"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxableObjectLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"sourceLine"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"__typename"}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"CheckoutLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"checkoutProductVariant"},"name":{"kind":"Name","value":"variant"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"sku"}},{"kind":"Field","name":{"kind":"Name","value":"product"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"taxClass"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}}]}}]}}]}}]}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"OrderLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"orderProductVariant"},"name":{"kind":"Name","value":"variant"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"sku"}},{"kind":"Field","name":{"kind":"Name","value":"product"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"taxClass"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}}]}}]}}]}}]}}]}},{"kind":"Field","name":{"kind":"Name","value":"quantity"}},{"kind":"Field","name":{"kind":"Name","value":"unitPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"totalPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"User"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"User"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"email"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxCustomerCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxCustomerCode","block":false}}]}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxBase"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxableObject"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"pricesEnteredWithTax"}},{"kind":"Field","name":{"kind":"Name","value":"currency"}},{"kind":"Field","name":{"kind":"Name","value":"channel"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"slug"}},{"kind":"Field","name":{"kind":"Name","value":"id"}}]}},{"kind":"Field","name":{"kind":"Name","value":"discounts"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"TaxDiscount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"address"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"Address"}}]}},{"kind":"Field","name":{"kind":"Name","value":"shippingPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"lines"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"TaxBaseLine"}}]}},{"kind":"Field","name":{"kind":"Name","value":"sourceObject"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"__typename"}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Checkout"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxEntityCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxEntityCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxCustomerCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxCustomerCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxExemptionStatus"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxExemptionStatus","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxShipFromAddress"},"name":{"kind":"Name","value":"privateMetafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxShipFromAddress","block":false}}]},{"kind":"Field","name":{"kind":"Name","value":"user"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"User"}}]}}]}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Order"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxEntityCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxEntityCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxCustomerCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxCustomerCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxExemptionStatus"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxExemptionStatus","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxShipFromAddress"},"name":{"kind":"Name","value":"privateMetafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxShipFromAddress","block":false}}]},{"kind":"Field","name":{"kind":"Name","value":"user"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"User"}}]}}]}}]}}]}}]} as unknown as DocumentNode; export const TaxClassFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxClass"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxClass"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}}]}}]} as unknown as DocumentNode; export const ChannelFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"Channel"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Channel"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}},{"kind":"Field","name":{"kind":"Name","value":"slug"}}]}}]} as unknown as DocumentNode; export const CountryWithCodeFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"CountryWithCode"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"CountryDisplay"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"country"}},{"kind":"Field","name":{"kind":"Name","value":"code"}},{"kind":"Field","name":{"kind":"Name","value":"__typename"}}]}}]} as unknown as DocumentNode; export const TaxConfigurationPerCountryFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxConfigurationPerCountry"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxConfigurationPerCountry"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"country"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"CountryWithCode"}},{"kind":"Field","name":{"kind":"Name","value":"__typename"}}]}},{"kind":"Field","name":{"kind":"Name","value":"chargeTaxes"}},{"kind":"Field","name":{"kind":"Name","value":"taxCalculationStrategy"}},{"kind":"Field","name":{"kind":"Name","value":"displayGrossPrices"}},{"kind":"Field","name":{"kind":"Name","value":"__typename"}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"CountryWithCode"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"CountryDisplay"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"country"}},{"kind":"Field","name":{"kind":"Name","value":"code"}},{"kind":"Field","name":{"kind":"Name","value":"__typename"}}]}}]} as unknown as DocumentNode; export const TaxConfigurationFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxConfiguration"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxConfiguration"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"channel"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"Channel"}}]}},{"kind":"Field","name":{"kind":"Name","value":"displayGrossPrices"}},{"kind":"Field","name":{"kind":"Name","value":"pricesEnteredWithTax"}},{"kind":"Field","name":{"kind":"Name","value":"chargeTaxes"}},{"kind":"Field","name":{"kind":"Name","value":"taxCalculationStrategy"}},{"kind":"Field","name":{"kind":"Name","value":"countries"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"TaxConfigurationPerCountry"}},{"kind":"Field","name":{"kind":"Name","value":"__typename"}}]}},{"kind":"Field","name":{"kind":"Name","value":"__typename"}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"CountryWithCode"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"CountryDisplay"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"country"}},{"kind":"Field","name":{"kind":"Name","value":"code"}},{"kind":"Field","name":{"kind":"Name","value":"__typename"}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"Channel"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Channel"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}},{"kind":"Field","name":{"kind":"Name","value":"slug"}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxConfigurationPerCountry"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxConfigurationPerCountry"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"country"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"CountryWithCode"}},{"kind":"Field","name":{"kind":"Name","value":"__typename"}}]}},{"kind":"Field","name":{"kind":"Name","value":"chargeTaxes"}},{"kind":"Field","name":{"kind":"Name","value":"taxCalculationStrategy"}},{"kind":"Field","name":{"kind":"Name","value":"displayGrossPrices"}},{"kind":"Field","name":{"kind":"Name","value":"__typename"}}]}}]} as unknown as DocumentNode; +export const WebhookMetadataFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"WebhookMetadata"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Event"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"issuedAt"}},{"kind":"Field","name":{"kind":"Name","value":"version"}}]}}]} as unknown as DocumentNode; export const OrderCancelledSubscriptionFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"OrderCancelledSubscription"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Order"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxId"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxId","block":false}}]},{"kind":"Field","name":{"kind":"Name","value":"channel"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"slug"}}]}}]}}]} as unknown as DocumentNode; export const OrderCancelledEventSubscriptionFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"OrderCancelledEventSubscription"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Event"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"__typename"}},{"kind":"FragmentSpread","name":{"kind":"Name","value":"WebhookMetadata"}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"OrderCancelled"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"order"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"OrderCancelledSubscription"}}]}},{"kind":"Field","name":{"kind":"Name","value":"recipient"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"privateMetadata"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"key"}},{"kind":"Field","name":{"kind":"Name","value":"value"}}]}}]}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"WebhookMetadata"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Event"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"issuedAt"}},{"kind":"Field","name":{"kind":"Name","value":"version"}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"OrderCancelledSubscription"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Order"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxId"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxId","block":false}}]},{"kind":"Field","name":{"kind":"Name","value":"channel"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"slug"}}]}}]}}]} as unknown as DocumentNode; export const OrderLineFragmentDoc = {"kind":"Document","definitions":[{"kind":"FragmentDefinition","name":{"kind":"Name","value":"OrderLine"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"OrderLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"productSku"}},{"kind":"Field","name":{"kind":"Name","value":"productVariantId"}},{"kind":"Field","name":{"kind":"Name","value":"productName"}},{"kind":"Field","name":{"kind":"Name","value":"quantity"}},{"kind":"Field","name":{"kind":"Name","value":"taxClass"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}}]}},{"kind":"Field","name":{"kind":"Name","value":"unitPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"net"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}}]}},{"kind":"Field","name":{"kind":"Name","value":"totalPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"net"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"tax"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"gross"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}}]}}]}}]} as unknown as DocumentNode; @@ -35130,6 +33181,6 @@ export const FetchChannelsDocument = {"kind":"Document","definitions":[{"kind":" export const OrderAvataxIdDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"OrderAvataxId"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"id"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"ID"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"order"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"id"},"value":{"kind":"Variable","name":{"kind":"Name","value":"id"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"channel"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"slug"}}]}},{"kind":"Field","alias":{"kind":"Name","value":"avataxId"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxId","block":false}}]}]}}]}}]} as unknown as DocumentNode; export const TaxClassesListDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"TaxClassesList"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"before"}},"type":{"kind":"NamedType","name":{"kind":"Name","value":"String"}}},{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"after"}},"type":{"kind":"NamedType","name":{"kind":"Name","value":"String"}}},{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"first"}},"type":{"kind":"NamedType","name":{"kind":"Name","value":"Int"}}},{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"last"}},"type":{"kind":"NamedType","name":{"kind":"Name","value":"Int"}}},{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"filter"}},"type":{"kind":"NamedType","name":{"kind":"Name","value":"TaxClassFilterInput"}}},{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"sortBy"}},"type":{"kind":"NamedType","name":{"kind":"Name","value":"TaxClassSortingInput"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"taxClasses"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"before"},"value":{"kind":"Variable","name":{"kind":"Name","value":"before"}}},{"kind":"Argument","name":{"kind":"Name","value":"after"},"value":{"kind":"Variable","name":{"kind":"Name","value":"after"}}},{"kind":"Argument","name":{"kind":"Name","value":"first"},"value":{"kind":"Variable","name":{"kind":"Name","value":"first"}}},{"kind":"Argument","name":{"kind":"Name","value":"last"},"value":{"kind":"Variable","name":{"kind":"Name","value":"last"}}},{"kind":"Argument","name":{"kind":"Name","value":"filter"},"value":{"kind":"Variable","name":{"kind":"Name","value":"filter"}}},{"kind":"Argument","name":{"kind":"Name","value":"sortBy"},"value":{"kind":"Variable","name":{"kind":"Name","value":"sortBy"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"edges"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"node"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"TaxClass"}}]}}]}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxClass"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxClass"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}}]}}]} as unknown as DocumentNode; export const TaxConfigurationsListDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"TaxConfigurationsList"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"before"}},"type":{"kind":"NamedType","name":{"kind":"Name","value":"String"}}},{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"after"}},"type":{"kind":"NamedType","name":{"kind":"Name","value":"String"}}},{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"first"}},"type":{"kind":"NamedType","name":{"kind":"Name","value":"Int"}}},{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"last"}},"type":{"kind":"NamedType","name":{"kind":"Name","value":"Int"}}},{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"filter"}},"type":{"kind":"NamedType","name":{"kind":"Name","value":"TaxConfigurationFilterInput"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"taxConfigurations"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"before"},"value":{"kind":"Variable","name":{"kind":"Name","value":"before"}}},{"kind":"Argument","name":{"kind":"Name","value":"after"},"value":{"kind":"Variable","name":{"kind":"Name","value":"after"}}},{"kind":"Argument","name":{"kind":"Name","value":"first"},"value":{"kind":"Variable","name":{"kind":"Name","value":"first"}}},{"kind":"Argument","name":{"kind":"Name","value":"last"},"value":{"kind":"Variable","name":{"kind":"Name","value":"last"}}},{"kind":"Argument","name":{"kind":"Name","value":"filter"},"value":{"kind":"Variable","name":{"kind":"Name","value":"filter"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"edges"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"node"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"TaxConfiguration"}},{"kind":"Field","name":{"kind":"Name","value":"__typename"}}]}},{"kind":"Field","name":{"kind":"Name","value":"__typename"}}]}},{"kind":"Field","name":{"kind":"Name","value":"__typename"}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"Channel"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Channel"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}},{"kind":"Field","name":{"kind":"Name","value":"slug"}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"CountryWithCode"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"CountryDisplay"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"country"}},{"kind":"Field","name":{"kind":"Name","value":"code"}},{"kind":"Field","name":{"kind":"Name","value":"__typename"}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxConfigurationPerCountry"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxConfigurationPerCountry"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"country"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"CountryWithCode"}},{"kind":"Field","name":{"kind":"Name","value":"__typename"}}]}},{"kind":"Field","name":{"kind":"Name","value":"chargeTaxes"}},{"kind":"Field","name":{"kind":"Name","value":"taxCalculationStrategy"}},{"kind":"Field","name":{"kind":"Name","value":"displayGrossPrices"}},{"kind":"Field","name":{"kind":"Name","value":"__typename"}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxConfiguration"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxConfiguration"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"channel"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"Channel"}}]}},{"kind":"Field","name":{"kind":"Name","value":"displayGrossPrices"}},{"kind":"Field","name":{"kind":"Name","value":"pricesEnteredWithTax"}},{"kind":"Field","name":{"kind":"Name","value":"chargeTaxes"}},{"kind":"Field","name":{"kind":"Name","value":"taxCalculationStrategy"}},{"kind":"Field","name":{"kind":"Name","value":"countries"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"TaxConfigurationPerCountry"}},{"kind":"Field","name":{"kind":"Name","value":"__typename"}}]}},{"kind":"Field","name":{"kind":"Name","value":"__typename"}}]}}]} as unknown as DocumentNode; -export const CalculateTaxesDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"subscription","name":{"kind":"Name","value":"CalculateTaxes"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"event"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"CalculateTaxesEvent"}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"WebhookMetadata"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Event"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"issuedAt"}},{"kind":"Field","name":{"kind":"Name","value":"version"}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxDiscount"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxableObjectDiscount"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"type"}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"Address"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Address"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"streetAddress1"}},{"kind":"Field","name":{"kind":"Name","value":"streetAddress2"}},{"kind":"Field","name":{"kind":"Name","value":"city"}},{"kind":"Field","name":{"kind":"Name","value":"countryArea"}},{"kind":"Field","name":{"kind":"Name","value":"postalCode"}},{"kind":"Field","name":{"kind":"Name","value":"country"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"code"}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxBaseLine"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxableObjectLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"sourceLine"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"__typename"}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"CheckoutLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"checkoutProductVariant"},"name":{"kind":"Name","value":"variant"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"sku"}},{"kind":"Field","name":{"kind":"Name","value":"product"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"taxClass"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}}]}}]}}]}}]}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"OrderLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"orderProductVariant"},"name":{"kind":"Name","value":"variant"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"sku"}},{"kind":"Field","name":{"kind":"Name","value":"product"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"taxClass"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}}]}}]}}]}}]}}]}},{"kind":"Field","name":{"kind":"Name","value":"quantity"}},{"kind":"Field","name":{"kind":"Name","value":"unitPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"totalPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"User"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"User"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"email"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxCustomerCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxCustomerCode","block":false}}]}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxBase"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxableObject"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"pricesEnteredWithTax"}},{"kind":"Field","name":{"kind":"Name","value":"currency"}},{"kind":"Field","name":{"kind":"Name","value":"channel"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"slug"}},{"kind":"Field","name":{"kind":"Name","value":"id"}}]}},{"kind":"Field","name":{"kind":"Name","value":"discounts"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"TaxDiscount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"address"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"Address"}}]}},{"kind":"Field","name":{"kind":"Name","value":"shippingPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"lines"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"TaxBaseLine"}}]}},{"kind":"Field","name":{"kind":"Name","value":"sourceObject"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"__typename"}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Checkout"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxEntityCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxEntityCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxCustomerCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxCustomerCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxExemptionStatus"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxExemptionStatus","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxShipFromAddress"},"name":{"kind":"Name","value":"privateMetafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxShipFromAddress","block":false}}]},{"kind":"Field","name":{"kind":"Name","value":"user"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"User"}}]}}]}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Order"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxEntityCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxEntityCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxCustomerCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxCustomerCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxExemptionStatus"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxExemptionStatus","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxShipFromAddress"},"name":{"kind":"Name","value":"privateMetafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxShipFromAddress","block":false}}]},{"kind":"Field","name":{"kind":"Name","value":"user"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"User"}}]}}]}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"CalculateTaxesEvent"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Event"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"__typename"}},{"kind":"FragmentSpread","name":{"kind":"Name","value":"WebhookMetadata"}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"CalculateTaxes"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"taxBase"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"TaxBase"}}]}},{"kind":"Field","name":{"kind":"Name","value":"recipient"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"privateMetadata"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"key"}},{"kind":"Field","name":{"kind":"Name","value":"value"}}]}}]}}]}}]}}]} as unknown as DocumentNode; +export const CalculateTaxesDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"subscription","name":{"kind":"Name","value":"CalculateTaxes"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"calculateTaxes"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"deferIf"},"value":{"kind":"EnumValue","value":"ADDRESS_MISSING"}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"taxBase"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"TaxBase"}}]}},{"kind":"Field","name":{"kind":"Name","value":"recipient"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"privateMetadata"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"key"}},{"kind":"Field","name":{"kind":"Name","value":"value"}}]}}]}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxDiscount"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxableObjectDiscount"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"type"}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"Address"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Address"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"streetAddress1"}},{"kind":"Field","name":{"kind":"Name","value":"streetAddress2"}},{"kind":"Field","name":{"kind":"Name","value":"city"}},{"kind":"Field","name":{"kind":"Name","value":"countryArea"}},{"kind":"Field","name":{"kind":"Name","value":"postalCode"}},{"kind":"Field","name":{"kind":"Name","value":"country"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"code"}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxBaseLine"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxableObjectLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"sourceLine"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"__typename"}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"CheckoutLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"checkoutProductVariant"},"name":{"kind":"Name","value":"variant"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"sku"}},{"kind":"Field","name":{"kind":"Name","value":"product"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"taxClass"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}}]}}]}}]}}]}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"OrderLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"orderProductVariant"},"name":{"kind":"Name","value":"variant"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"sku"}},{"kind":"Field","name":{"kind":"Name","value":"product"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"taxClass"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}}]}}]}}]}}]}}]}},{"kind":"Field","name":{"kind":"Name","value":"quantity"}},{"kind":"Field","name":{"kind":"Name","value":"unitPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"totalPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"User"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"User"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"email"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxCustomerCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxCustomerCode","block":false}}]}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"TaxBase"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"TaxableObject"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"pricesEnteredWithTax"}},{"kind":"Field","name":{"kind":"Name","value":"currency"}},{"kind":"Field","name":{"kind":"Name","value":"channel"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"slug"}},{"kind":"Field","name":{"kind":"Name","value":"id"}}]}},{"kind":"Field","name":{"kind":"Name","value":"discounts"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"TaxDiscount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"address"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"Address"}}]}},{"kind":"Field","name":{"kind":"Name","value":"shippingPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"lines"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"TaxBaseLine"}}]}},{"kind":"Field","name":{"kind":"Name","value":"sourceObject"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"__typename"}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Checkout"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxEntityCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxEntityCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxCustomerCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxCustomerCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxExemptionStatus"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxExemptionStatus","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxShipFromAddress"},"name":{"kind":"Name","value":"privateMetafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxShipFromAddress","block":false}}]},{"kind":"Field","name":{"kind":"Name","value":"user"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"User"}}]}}]}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Order"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxEntityCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxEntityCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxCustomerCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxCustomerCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxExemptionStatus"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxExemptionStatus","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxShipFromAddress"},"name":{"kind":"Name","value":"privateMetafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxShipFromAddress","block":false}}]},{"kind":"Field","name":{"kind":"Name","value":"user"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"User"}}]}}]}}]}}]}}]} as unknown as DocumentNode; export const OrderCancelledSubscriptionDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"subscription","name":{"kind":"Name","value":"OrderCancelledSubscription"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"event"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"OrderCancelledEventSubscription"}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"WebhookMetadata"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Event"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"issuedAt"}},{"kind":"Field","name":{"kind":"Name","value":"version"}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"OrderCancelledSubscription"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Order"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxId"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxId","block":false}}]},{"kind":"Field","name":{"kind":"Name","value":"channel"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"slug"}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"OrderCancelledEventSubscription"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Event"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"__typename"}},{"kind":"FragmentSpread","name":{"kind":"Name","value":"WebhookMetadata"}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"OrderCancelled"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"order"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"OrderCancelledSubscription"}}]}},{"kind":"Field","name":{"kind":"Name","value":"recipient"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"privateMetadata"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"key"}},{"kind":"Field","name":{"kind":"Name","value":"value"}}]}}]}}]}}]}}]} as unknown as DocumentNode; export const OrderConfirmedSubscriptionDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"subscription","name":{"kind":"Name","value":"OrderConfirmedSubscription"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"event"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"OrderConfirmedEventSubscription"}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"WebhookMetadata"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Event"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"issuedAt"}},{"kind":"Field","name":{"kind":"Name","value":"version"}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"User"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"User"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"email"}},{"kind":"Field","alias":{"kind":"Name","value":"avataxCustomerCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxCustomerCode","block":false}}]}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"Address"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Address"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"streetAddress1"}},{"kind":"Field","name":{"kind":"Name","value":"streetAddress2"}},{"kind":"Field","name":{"kind":"Name","value":"city"}},{"kind":"Field","name":{"kind":"Name","value":"countryArea"}},{"kind":"Field","name":{"kind":"Name","value":"postalCode"}},{"kind":"Field","name":{"kind":"Name","value":"country"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"code"}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"OrderLine"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"OrderLine"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"productSku"}},{"kind":"Field","name":{"kind":"Name","value":"productVariantId"}},{"kind":"Field","name":{"kind":"Name","value":"productName"}},{"kind":"Field","name":{"kind":"Name","value":"quantity"}},{"kind":"Field","name":{"kind":"Name","value":"taxClass"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}}]}},{"kind":"Field","name":{"kind":"Name","value":"unitPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"net"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}}]}},{"kind":"Field","name":{"kind":"Name","value":"totalPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"net"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"tax"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"gross"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}}]}}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"OrderConfirmedSubscription"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Order"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"number"}},{"kind":"Field","name":{"kind":"Name","value":"userEmail"}},{"kind":"Field","name":{"kind":"Name","value":"user"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"User"}}]}},{"kind":"Field","alias":{"kind":"Name","value":"avataxCustomerCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxCustomerCode","block":false}}]},{"kind":"Field","name":{"kind":"Name","value":"created"}},{"kind":"Field","name":{"kind":"Name","value":"status"}},{"kind":"Field","name":{"kind":"Name","value":"channel"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"slug"}},{"kind":"Field","name":{"kind":"Name","value":"taxConfiguration"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"pricesEnteredWithTax"}},{"kind":"Field","name":{"kind":"Name","value":"taxCalculationStrategy"}}]}}]}},{"kind":"Field","name":{"kind":"Name","value":"shippingAddress"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"Address"}}]}},{"kind":"Field","name":{"kind":"Name","value":"billingAddress"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"Address"}}]}},{"kind":"Field","name":{"kind":"Name","value":"total"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"currency"}},{"kind":"Field","name":{"kind":"Name","value":"net"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"tax"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}}]}},{"kind":"Field","name":{"kind":"Name","value":"shippingPrice"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"gross"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}},{"kind":"Field","name":{"kind":"Name","value":"net"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"amount"}}]}}]}},{"kind":"Field","name":{"kind":"Name","value":"lines"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"OrderLine"}}]}},{"kind":"Field","alias":{"kind":"Name","value":"avataxEntityCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxEntityCode","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxTaxCalculationDate"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxTaxCalculationDate","block":false}}]},{"kind":"Field","alias":{"kind":"Name","value":"avataxDocumentCode"},"name":{"kind":"Name","value":"metafield"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"key"},"value":{"kind":"StringValue","value":"avataxDocumentCode","block":false}}]}]}},{"kind":"FragmentDefinition","name":{"kind":"Name","value":"OrderConfirmedEventSubscription"},"typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"Event"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"__typename"}},{"kind":"FragmentSpread","name":{"kind":"Name","value":"WebhookMetadata"}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"OrderConfirmed"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"order"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"FragmentSpread","name":{"kind":"Name","value":"OrderConfirmedSubscription"}}]}}]}},{"kind":"Field","name":{"kind":"Name","value":"recipient"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"privateMetadata"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"key"}},{"kind":"Field","name":{"kind":"Name","value":"value"}}]}}]}}]}}]} as unknown as DocumentNode; \ No newline at end of file diff --git a/apps/avatax/graphql.config.ts b/apps/avatax/graphql.config.ts index c3cc7ea334..6f9effc3ac 100644 --- a/apps/avatax/graphql.config.ts +++ b/apps/avatax/graphql.config.ts @@ -66,6 +66,8 @@ const config: IGraphQLConfig = { UUID: "string", WeightScalar: "number", Day: "string", + Hour: "number", + PositiveInt: "number", }, }, plugins: [ diff --git a/apps/avatax/graphql/fragments/CalculateTaxesEvent.graphql b/apps/avatax/graphql/fragments/CalculateTaxesEvent.graphql index 6481de46b0..47930e6c4a 100644 --- a/apps/avatax/graphql/fragments/CalculateTaxesEvent.graphql +++ b/apps/avatax/graphql/fragments/CalculateTaxesEvent.graphql @@ -1,15 +1,14 @@ -fragment CalculateTaxesEvent on Event { - __typename - ...WebhookMetadata - ... on CalculateTaxes { - taxBase { - ...TaxBase - } - recipient { - privateMetadata { - key - value - } +fragment CalculateTaxesEvent on CalculateTaxes { + taxBase { + ...TaxBase + } + recipient { + privateMetadata { + key + value } } + __typename + issuedAt + version } diff --git a/apps/avatax/graphql/schema.graphql b/apps/avatax/graphql/schema.graphql index 703aba8bcb..0687be0883 100644 --- a/apps/avatax/graphql/schema.graphql +++ b/apps/avatax/graphql/schema.graphql @@ -8,7 +8,7 @@ schema { directive @doc( """Name of the grouping category""" category: String! -) on ENUM | FIELD | FIELD_DEFINITION | INPUT_OBJECT | OBJECT +) on ENUM | FIELD | FIELD_DEFINITION | INPUT_OBJECT | OBJECT | INTERFACE """Webhook events triggered by a specific location.""" directive @webhookEventsInfo( @@ -30,10 +30,10 @@ type Query { """ List of all available webhook events. - + Requires one of the following permissions: MANAGE_APPS. """ - webhookEvents: [WebhookEvent!] @doc(category: "Webhooks") @deprecated(reason: "This field will be removed in Saleor 4.0. Use `WebhookEventTypeAsyncEnum` and `WebhookEventTypeSyncEnum` to get available event types.") + webhookEvents: [WebhookEvent!] @doc(category: "Webhooks") @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. @@ -45,24 +45,20 @@ type Query { """ Look up a warehouse by ID. - + Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS, MANAGE_SHIPPING. """ warehouse( """ID of a warehouse.""" id: ID - """ - External ID of a warehouse. - - Added in Saleor 3.10. - """ + """External ID of a warehouse.""" externalReference: String ): Warehouse @doc(category: "Products") """ List of warehouses. - + Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS, MANAGE_SHIPPING. """ warehouses( @@ -88,7 +84,7 @@ type Query { """ Returns a list of all translatable items of a given kind. - + Requires one of the following permissions: MANAGE_TRANSLATIONS. """ translations( @@ -114,7 +110,7 @@ type Query { """ Lookup a translatable item by ID. - + Requires one of the following permissions: MANAGE_TRANSLATIONS. """ translation( @@ -127,9 +123,7 @@ type Query { """ Look up a tax configuration. - - Added in Saleor 3.9. - + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. """ taxConfiguration( @@ -139,9 +133,7 @@ type Query { """ List of tax configurations. - - Added in Saleor 3.9. - + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. """ taxConfigurations( @@ -167,9 +159,7 @@ type Query { """ Look up a tax class. - - Added in Saleor 3.9. - + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. """ taxClass( @@ -179,9 +169,7 @@ type Query { """ List of tax classes. - - Added in Saleor 3.9. - + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. """ taxClasses( @@ -210,7 +198,7 @@ type Query { """ Tax class rates grouped by country. - + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. """ taxCountryConfiguration( @@ -223,7 +211,7 @@ type Query { """ Look up a stock by ID - + Requires one of the following permissions: MANAGE_PRODUCTS. """ stock( @@ -233,7 +221,7 @@ type Query { """ List of stocks. - + Requires one of the following permissions: MANAGE_PRODUCTS. """ stocks( @@ -261,21 +249,26 @@ type Query { """ Order related settings from site settings. Returns `orderSettings` for the first `channel` in alphabetical order. - + Requires one of the following permissions: MANAGE_ORDERS. """ - orderSettings: OrderSettings @doc(category: "Orders") @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `channel` query to fetch the `orderSettings` field instead.") + orderSettings: OrderSettings @doc(category: "Orders") @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") + """ + Refunds related settings. Returns `RefundSettings` configuration, global for the entire shop. + """ + refundSettings: RefundSettings! @doc(category: "Shop") + """ Look up a shipping zone by ID. - + Requires one of the following permissions: MANAGE_SHIPPING. """ shippingZone( @@ -288,7 +281,7 @@ type Query { """ List of the shop's shipping zones. - + Requires one of the following permissions: MANAGE_SHIPPING. """ shippingZones( @@ -317,7 +310,7 @@ type Query { """ Look up digital content by ID. - + Requires one of the following permissions: MANAGE_PRODUCTS. """ digitalContent( @@ -327,7 +320,7 @@ type Query { """ List of digital content. - + Requires one of the following permissions: MANAGE_PRODUCTS. """ digitalContents( @@ -353,13 +346,7 @@ type Query { """Filtering options for categories.""" filter: CategoryFilterInput - """ - Where filtering options. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Where filtering options for categories.""" where: CategoryWhereInput """Sort categories.""" @@ -392,18 +379,32 @@ type Query { """Slug of the category""" slug: String + + """ + Language code of the category slug, omit to use primary slug. + + Added in Saleor 3.21. + """ + slugLanguageCode: LanguageCodeEnum ): Category @doc(category: "Products") """ - Look up a collection by ID. Requires one of the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. + 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. """ collection( """ID of the collection.""" id: ID - """Slug of the category""" + """Slug of the collection""" slug: String + """ + Language code of the collection slug, omit to use primary slug. + + Added in Saleor 3.21. + """ + slugLanguageCode: LanguageCodeEnum + """Slug of a channel for which the data should be returned.""" channel: String ): Collection @doc(category: "Products") @@ -415,13 +416,7 @@ type Query { """Filtering options for collections.""" filter: CollectionFilterInput - """ - Where filtering options. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Where filtering options for collections.""" where: CollectionWhereInput """Sort collections.""" @@ -458,10 +453,13 @@ type Query { slug: String """ - External ID of the product. - - Added in Saleor 3.10. + Language code of the product slug, omit to use primary slug. + + Added in Saleor 3.21. """ + slugLanguageCode: LanguageCodeEnum + + """External ID of the product.""" externalReference: String """Slug of a channel for which the data should be returned.""" @@ -473,25 +471,15 @@ type Query { """ products( """Filtering options for products.""" - filter: ProductFilterInput + filter: ProductFilterInput @deprecated(reason: "Use `where` filter instead.") - """ - Where filtering options. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Where filtering options for products.""" where: ProductWhereInput """Sort products.""" sortBy: ProductOrder - """ - Search products. - - Added in Saleor 3.14. - """ + """Search products.""" search: String """Slug of a channel for which the data should be returned.""" @@ -555,11 +543,7 @@ type Query { """SKU of the product variant.""" sku: String - """ - External ID of the product. - - Added in Saleor 3.10. - """ + """External ID of the product.""" externalReference: String """Slug of a channel for which the data should be returned.""" @@ -576,17 +560,18 @@ type Query { """Slug of a channel for which the data should be returned.""" channel: String - """Filtering options for product variant.""" - filter: ProductVariantFilterInput + """Filtering options for product variants.""" + filter: ProductVariantFilterInput @deprecated(reason: "Use `where` filter instead.") + + """Where filtering options for product variants.""" + where: ProductVariantWhereInput """ - Where filtering options. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. + Search product variants. + + Added in Saleor 3.22. """ - where: ProductVariantWhereInput + search: String """Sort products variants.""" sortBy: ProductVariantSortingInput @@ -610,7 +595,7 @@ type Query { """ List of top selling products. - + Requires one of the following permissions: MANAGE_PRODUCTS. """ reportProductSales( @@ -635,11 +620,11 @@ 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(reason: "This field will be removed in Saleor 4.0.") + ): ProductVariantCountableConnection @doc(category: "Products") @deprecated """ Look up a payment by ID. - + Requires one of the following permissions: MANAGE_ORDERS. """ payment( @@ -649,7 +634,7 @@ type Query { """ List of payments. - + Requires one of the following permissions: MANAGE_ORDERS. """ payments( @@ -675,12 +660,8 @@ type Query { """ Look up a transaction by ID. - - Added in Saleor 3.6. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - - Requires one of the following permissions: HANDLE_PAYMENTS. + + Requires one of the following permissions: HANDLE_PAYMENTS, MANAGE_ORDERS. """ transaction( """ @@ -694,6 +675,34 @@ type Query { token: UUID ): TransactionItem @doc(category: "Payments") + """ + 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 @doc(category: "Payments") + """Look up a page by ID or slug.""" page( """ID of the page.""" @@ -701,6 +710,20 @@ type Query { """The slug of the page.""" slug: String + + """ + Language code of the page slug, omit to use primary slug. + + Added in Saleor 3.21. + """ + slugLanguageCode: LanguageCodeEnum + + """ + Slug of a channel for which the data should be returned. + + Added in Saleor 3.22. + """ + channel: String ): Page @doc(category: "Pages") """List of the shop's pages.""" @@ -709,7 +732,28 @@ type Query { sortBy: PageSortingInput """Filtering options for pages.""" - filter: PageFilterInput + filter: PageFilterInput @deprecated(reason: "+ Use `where` and `search` instead.") + + """ + Search pages. Overrides filter.search input. + + Added in Saleor 3.22. + """ + search: String + + """ + Where filtering options for pages. + + Added in Saleor 3.22. + """ + where: PageWhereInput + + """ + Slug of a channel for which the data should be returned. + + Added in Saleor 3.22. + """ + channel: String """Return the elements in the list that come before the specified cursor.""" before: String @@ -761,7 +805,7 @@ type Query { """ List of activity events to display on homepage (at the moment it only contains order-events). - + Requires one of the following permissions: MANAGE_ORDERS. """ homepageEvents( @@ -780,7 +824,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(reason: "This field will be removed in Saleor 4.0.") + ): OrderEventCountableConnection @doc(category: "Orders") @deprecated """Look up an order by ID or external reference.""" order( @@ -788,18 +832,16 @@ type Query { id: ID """ - External ID of an order. - - Added in Saleor 3.10.. - + External ID of an order. + Requires one of the following permissions: MANAGE_ORDERS. """ externalReference: String ): Order @doc(category: "Orders") """ - List of orders. - + List of 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_ORDERS. """ orders( @@ -807,11 +849,25 @@ type Query { sortBy: OrderSortingInput """Filtering options for orders.""" - filter: OrderFilterInput + filter: OrderFilterInput @deprecated(reason: "Use `where` filter instead.") + + """ + Where filtering options for orders. + + Added in Saleor 3.22. + """ + where: OrderWhereInput """Slug of a channel for which the data should be returned.""" channel: String + """ + Search orders. + + Added in Saleor 3.22. + """ + search: String + """Return the elements in the list that come before the specified cursor.""" before: String @@ -830,8 +886,8 @@ type Query { ): OrderCountableConnection @doc(category: "Orders") """ - List of draft orders. - + List of draft 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_ORDERS. """ draftOrders( @@ -839,7 +895,21 @@ type Query { sortBy: OrderSortingInput """Filtering options for draft orders.""" - filter: OrderDraftFilterInput + filter: OrderDraftFilterInput @deprecated(reason: "Use `where` filter instead.") + + """ + Where filtering options for draft orders. + + Added in Saleor 3.22. + """ + where: DraftOrderWhereInput + + """ + Search orders. + + Added in Saleor 3.22. + """ + search: String """Return the elements in the list that come before the specified cursor.""" before: String @@ -860,7 +930,7 @@ type Query { """ Return the total sales amount from a specific period. - + Requires one of the following permissions: MANAGE_ORDERS. """ ordersTotal( @@ -869,13 +939,13 @@ type Query { """Slug of a channel for which the data should be returned.""" channel: String - ): TaxedMoney @doc(category: "Orders") @deprecated(reason: "This field will be removed in Saleor 4.0.") + ): TaxedMoney @doc(category: "Orders") @deprecated """Look up an order by token.""" orderByToken( """The order's token.""" token: UUID! - ): Order @doc(category: "Orders") @deprecated(reason: "This field will be removed in Saleor 4.0.") + ): Order @doc(category: "Orders") @deprecated """Look up a navigation menu by ID or name.""" menu( @@ -901,9 +971,9 @@ type Query { sortBy: MenuSortingInput """ - Filtering options for menus. - - `slug`: This field will be removed in Saleor 4.0. Use `slugs` instead. + Filtering options for menus. + + `slug`: Use `slugs` instead. """ filter: MenuFilterInput @@ -963,7 +1033,7 @@ type Query { """ Look up a gift card by ID. - + Requires one of the following permissions: MANAGE_GIFT_CARD. """ giftCard( @@ -973,30 +1043,18 @@ type Query { """ List of gift cards. - + Requires one of the following permissions: MANAGE_GIFT_CARD. """ giftCards( - """ - Sort gift cards. - - Added in Saleor 3.1. - """ + """Sort gift cards.""" sortBy: GiftCardSortingInput - """ - Filtering options for gift cards. - - Added in Saleor 3.1. - """ + """Filtering options for gift cards.""" filter: GiftCardFilterInput """ Search gift cards by email and name of user, who created or used the gift card, and by code. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ search: String @@ -1019,18 +1077,14 @@ type Query { """ List of gift card currencies. - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_GIFT_CARD. """ giftCardCurrencies: [String!]! @doc(category: "Gift cards") """ List of gift card tags. - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_GIFT_CARD. """ giftCardTags( @@ -1056,7 +1110,7 @@ type Query { """ Look up a plugin by ID. - + Requires one of the following permissions: MANAGE_PLUGINS. """ plugin( @@ -1066,7 +1120,7 @@ type Query { """ List of plugins. - + Requires one of the following permissions: MANAGE_PLUGINS. """ plugins( @@ -1095,7 +1149,7 @@ type Query { """ Look up a sale by ID. - + Requires one of the following permissions: MANAGE_DISCOUNTS. """ sale( @@ -1104,11 +1158,11 @@ type Query { """Slug of a channel for which the data should be returned.""" channel: String - ): Sale @doc(category: "Discounts") @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `promotion` query instead.") + ): Sale @doc(category: "Discounts") @deprecated(reason: "Use the `promotion` query instead.") """ List of the shop's sales. - + Requires one of the following permissions: MANAGE_DISCOUNTS. """ sales( @@ -1118,12 +1172,8 @@ type Query { """Sort sales.""" sortBy: SaleSortingInput - """ - Search sales by name, value or type. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `filter.search` input instead. - """ - query: String + """Search sales by name, value or type.""" + query: String @deprecated(reason: "Use `filter.search` input instead.") """Slug of a channel for which the data should be returned.""" channel: String @@ -1143,11 +1193,11 @@ 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: "This field will be removed in Saleor 4.0. Use the `promotions` query instead.") + ): SaleCountableConnection @doc(category: "Discounts") @deprecated(reason: "Use the `promotions` query instead.") """ Look up a voucher by ID. - + Requires one of the following permissions: MANAGE_DISCOUNTS. """ voucher( @@ -1160,7 +1210,7 @@ type Query { """ List of the shop's vouchers. - + Requires one of the following permissions: MANAGE_DISCOUNTS. """ vouchers( @@ -1170,12 +1220,8 @@ type Query { """Sort voucher.""" sortBy: VoucherSortingInput - """ - Search vouchers by name or code. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `filter.search` input instead. - """ - query: String + """Search vouchers by name or code.""" + query: String @deprecated(reason: "Use `filter.search` input instead.") """Slug of a channel for which the data should be returned.""" channel: String @@ -1199,11 +1245,7 @@ type Query { """ Look up a promotion by ID. - - Added in Saleor 3.17. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_DISCOUNTS. """ promotion( @@ -1213,15 +1255,11 @@ type Query { """ List of the promotions. - - Added in Saleor 3.17. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_DISCOUNTS. """ promotions( - """Where filtering options.""" + """Where filtering options for promotions.""" where: PromotionWhereInput """Sort promotions.""" @@ -1246,7 +1284,7 @@ type Query { """ Look up a export file by ID. - + Requires one of the following permissions: MANAGE_PRODUCTS. """ exportFile( @@ -1256,7 +1294,7 @@ type Query { """ List of export files. - + Requires one of the following permissions: MANAGE_PRODUCTS. """ exportFiles( @@ -1284,47 +1322,31 @@ type Query { ): ExportFileCountableConnection """List of all tax rates available from tax gateway.""" - taxTypes: [TaxType!] @doc(category: "Taxes") @deprecated(reason: "This field will be removed in Saleor 4.0. Use `taxClasses` field instead.") + taxTypes: [TaxType!] @doc(category: "Taxes") @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. """ checkout( - """ - The checkout's ID. - - Added in Saleor 3.4. - """ + """The checkout's ID.""" id: ID - """ - The checkout's token. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - token: UUID + """The checkout's token.""" + token: UUID @deprecated(reason: "Use `id` instead.") ): Checkout @doc(category: "Checkout") """ - List of checkouts. - + 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. + Requires one of the following permissions: MANAGE_CHECKOUTS, HANDLE_PAYMENTS. """ checkouts( - """ - Sort checkouts. - - Added in Saleor 3.1. - """ + """Sort checkouts.""" sortBy: CheckoutSortingInput - """ - Filtering options for checkouts. - - Added in Saleor 3.1. - """ + """Filtering options for checkouts.""" filter: CheckoutFilterInput """Slug of a channel for which the data should be returned.""" @@ -1348,8 +1370,8 @@ type Query { ): CheckoutCountableConnection @doc(category: "Checkout") """ - List of checkout lines. - + 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. + Requires one of the following permissions: MANAGE_CHECKOUTS. """ checkoutLines( @@ -1375,17 +1397,13 @@ type Query { """ID of the channel.""" id: ID - """ - Slug of the channel. - - Added in Saleor 3.6. - """ + """Slug of the channel.""" slug: String ): Channel @doc(category: "Channels") """ List of all channels. - + Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. """ channels: [Channel!] @doc(category: "Channels") @@ -1393,22 +1411,12 @@ type Query { """List of the shop's attributes.""" attributes( """Filtering options for attributes.""" - filter: AttributeFilterInput + filter: AttributeFilterInput @deprecated(reason: "Use `where` filter instead.") - """ - Filtering options for attributes. - - Added in Saleor 3.11. - """ + """Where filtering options for attributes.""" where: AttributeWhereInput - """ - Search attributes. - - Added in Saleor 3.11. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Search attributes.""" search: String """Sorting options for attributes.""" @@ -1442,24 +1450,20 @@ type Query { """Slug of the attribute.""" slug: String - """ - External ID of the attribute. - - Added in Saleor 3.10. - """ + """External ID of the attribute.""" externalReference: String ): Attribute @doc(category: "Attributes") """ List of all apps installations - + Requires one of the following permissions: MANAGE_APPS. """ appsInstallations: [AppInstallation!]! @doc(category: "Apps") """ List of the apps. - + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, MANAGE_APPS. """ apps( @@ -1488,7 +1492,7 @@ type Query { """ Look up an app by ID. If ID is not provided, return the currently authenticated app. - + Requires one of the following permissions: AUTHENTICATED_STAFF_USER AUTHENTICATED_APP. The authenticated app has access to its resources. Fetching different apps requires MANAGE_APPS permission. """ app( @@ -1498,9 +1502,7 @@ type Query { """ List of all extensions. - - Added in Saleor 3.1. - + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. """ appExtensions( @@ -1526,9 +1528,7 @@ type Query { """ Look up an app extension by ID. - - Added in Saleor 3.1. - + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. """ appExtension( @@ -1553,7 +1553,7 @@ type Query { """ Look up an address by ID. - + Requires one of the following permissions: MANAGE_USERS, OWNER. """ address( @@ -1563,16 +1563,30 @@ type Query { """ 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. - + Requires one of the following permissions: MANAGE_ORDERS, MANAGE_USERS. """ customers( """Filtering options for customers.""" - filter: CustomerFilterInput + filter: CustomerFilterInput @deprecated(reason: "Use `where` filter instead.") + + """ + Where filtering options for customers. + + Added in Saleor 3.22. + """ + where: CustomerWhereInput """Sort customers.""" sortBy: UserSortingInput + """ + Search customers. + + Added in Saleor 3.22. + """ + search: String + """Return the elements in the list that come before the specified cursor.""" before: String @@ -1592,7 +1606,7 @@ type Query { """ List of permission groups. - + Requires one of the following permissions: MANAGE_STAFF. """ permissionGroups( @@ -1621,7 +1635,7 @@ type Query { """ Look up permission group by ID. - + Requires one of the following permissions: MANAGE_STAFF. """ permissionGroup( @@ -1634,7 +1648,7 @@ type Query { """ List of the shop's staff users. - + Requires one of the following permissions: MANAGE_STAFF. """ staffUsers( @@ -1663,7 +1677,7 @@ type Query { """ Look up a user by ID or email address. - + Requires one of the following permissions: MANAGE_STAFF, MANAGE_USERS, MANAGE_ORDERS. """ user( @@ -1673,11 +1687,7 @@ type Query { """Email address of the user.""" email: String - """ - External ID of the user. - - Added in Saleor 3.10. - """ + """External ID of the user.""" externalReference: String ): User @doc(category: "Users") _entities(representations: [_Any]): [_Entity] @@ -1693,7 +1703,7 @@ type Webhook implements Node @doc(category: "Webhooks") { name: String """List of webhook events.""" - events: [WebhookEvent!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `asyncEvents` or `syncEvents` instead.") + events: [WebhookEvent!]! @deprecated(reason: "Use `asyncEvents` or `syncEvents` instead.") """List of synchronous webhook events.""" syncEvents: [WebhookEventSync!]! @@ -1736,19 +1746,16 @@ type Webhook implements Node @doc(category: "Webhooks") { isActive: Boolean! """Used to create a hash signature for each payload.""" - secretKey: String @deprecated(reason: "This field will be removed in Saleor 4.0. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS.") + secretKey: String @deprecated(reason: "As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS.") """Used to define payloads for specific events.""" subscriptionQuery: String - """ - Custom headers, which will be added to HTTP request. - - Added in Saleor 3.12. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Custom headers, which will be added to HTTP request.""" customHeaders: JSONString + + """Conditions under which webhook delivery is deferred.""" + deferIfConditions: [String!] } """An object with an ID""" @@ -1768,12 +1775,8 @@ type WebhookEvent @doc(category: "Webhooks") { """Enum determining type of webhook.""" enum WebhookEventTypeEnum @doc(category: "Webhooks") { - """ - All the events. - - DEPRECATED: this value will be removed in Saleor 4.0. - """ - ANY_EVENTS + """All the events.""" + ANY_EVENTS @deprecated """An account confirmation is requested.""" ACCOUNT_CONFIRMATION_REQUESTED @@ -1868,30 +1871,16 @@ enum WebhookEventTypeEnum @doc(category: "Webhooks") { """A gift card is deleted.""" GIFT_CARD_DELETED - """ - A gift card has been sent. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """A gift card has been sent.""" GIFT_CARD_SENT """A gift card status is changed.""" GIFT_CARD_STATUS_CHANGED - """ - A gift card metadata is updated. - - Added in Saleor 3.8. - """ + """A gift card metadata is updated.""" GIFT_CARD_METADATA_UPDATED - """ - A gift card export is completed. - - Added in Saleor 3.16. - """ + """A gift card export is completed.""" GIFT_CARD_EXPORT_COMPLETED """A new menu created.""" @@ -1920,13 +1909,7 @@ enum WebhookEventTypeEnum @doc(category: "Webhooks") { """ ORDER_CONFIRMED - """ - Payment has been made. The order may be partially or fully paid. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Payment has been made. The order may be partially or fully paid.""" ORDER_PAID """Payment is made and an order is fully paid.""" @@ -1934,20 +1917,10 @@ enum WebhookEventTypeEnum @doc(category: "Webhooks") { """ The order received a refund. The order may be partially or fully refunded. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ ORDER_REFUNDED - """ - The order is fully refunded. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """The order is fully refunded.""" ORDER_FULLY_REFUNDED """ @@ -1964,20 +1937,10 @@ enum WebhookEventTypeEnum @doc(category: "Webhooks") { """An order is fulfilled.""" ORDER_FULFILLED - """ - An order metadata is updated. - - Added in Saleor 3.8. - """ + """An order metadata is updated.""" ORDER_METADATA_UPDATED - """ - Orders are imported. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Orders are imported.""" ORDER_BULK_CREATED """A new fulfillment is created.""" @@ -1989,11 +1952,7 @@ enum WebhookEventTypeEnum @doc(category: "Webhooks") { """A fulfillment is approved.""" FULFILLMENT_APPROVED - """ - A fulfillment metadata is updated. - - Added in Saleor 3.8. - """ + """A fulfillment metadata is updated.""" FULFILLMENT_METADATA_UPDATED FULFILLMENT_TRACKING_NUMBER_UPDATED @@ -2060,11 +2019,7 @@ enum WebhookEventTypeEnum @doc(category: "Webhooks") { """A customer account is deleted.""" CUSTOMER_DELETED - """ - A customer account metadata is updated. - - Added in Saleor 3.8. - """ + """A customer account metadata is updated.""" CUSTOMER_METADATA_UPDATED """A new collection is created.""" @@ -2076,11 +2031,7 @@ enum WebhookEventTypeEnum @doc(category: "Webhooks") { """A collection is deleted.""" COLLECTION_DELETED - """ - A collection metadata is updated. - - Added in Saleor 3.8. - """ + """A collection metadata is updated.""" COLLECTION_METADATA_UPDATED """A new product is created.""" @@ -2092,39 +2043,19 @@ enum WebhookEventTypeEnum @doc(category: "Webhooks") { """A product is deleted.""" PRODUCT_DELETED - """ - A product metadata is updated. - - Added in Saleor 3.8. - """ + """A product metadata is updated.""" PRODUCT_METADATA_UPDATED - """ - A product export is completed. - - Added in Saleor 3.16. - """ + """A product export is completed.""" PRODUCT_EXPORT_COMPLETED - """ - A new product media is created. - - Added in Saleor 3.12. - """ + """A new product media is created.""" PRODUCT_MEDIA_CREATED - """ - A product media is updated. - - Added in Saleor 3.12. - """ + """A product media is updated.""" PRODUCT_MEDIA_UPDATED - """ - A product media is deleted. - - Added in Saleor 3.12. - """ + """A product media is deleted.""" PRODUCT_MEDIA_DELETED """A new product variant is created.""" @@ -2138,11 +2069,7 @@ enum WebhookEventTypeEnum @doc(category: "Webhooks") { """ PRODUCT_VARIANT_DELETED - """ - A product variant metadata is updated. - - Added in Saleor 3.8. - """ + """A product variant metadata is updated.""" PRODUCT_VARIANT_METADATA_UPDATED """A product variant is out of stock.""" @@ -2161,21 +2088,26 @@ enum WebhookEventTypeEnum @doc(category: "Webhooks") { A checkout is updated. It also triggers all updates related to the checkout. """ CHECKOUT_UPDATED - CHECKOUT_FULLY_PAID """ - A checkout metadata is updated. - - Added in Saleor 3.8. + A checkout was fully authorized (its `authorizeStatus` is `FULL`). + + This event is emitted only for checkouts whose payments are processed through the Transaction API. """ - CHECKOUT_METADATA_UPDATED + CHECKOUT_FULLY_AUTHORIZED """ - User notification triggered. - - DEPRECATED: this value will be removed in Saleor 4.0. See the docs for more details about migrating from NOTIFY_USER to other events: https://docs.saleor.io/docs/next/upgrade-guides/notify-user-deprecation + A checkout was fully paid (its `chargeStatus` is `FULL` or `OVERCHARGED`). This event is not sent if payments are only authorized but not fully charged. + + This event is emitted only for checkouts whose payments are processed through the Transaction API. """ - NOTIFY_USER + CHECKOUT_FULLY_PAID + + """A checkout metadata is updated.""" + CHECKOUT_METADATA_UPDATED + + """User notification triggered.""" + NOTIFY_USER @deprecated(reason: "See the docs for more details about migrating from NOTIFY_USER to other events: https://docs.saleor.io/upgrade-guides/core/3-16-to-3-17#migrating-from-notify_user") """A new page is created.""" PAGE_CREATED @@ -2222,11 +2154,7 @@ enum WebhookEventTypeEnum @doc(category: "Webhooks") { """A shipping zone is deleted.""" SHIPPING_ZONE_DELETED - """ - A shipping zone metadata is updated. - - Added in Saleor 3.8. - """ + """A shipping zone metadata is updated.""" SHIPPING_ZONE_METADATA_UPDATED """A new staff user is created.""" @@ -2241,11 +2169,7 @@ enum WebhookEventTypeEnum @doc(category: "Webhooks") { """Setting a new password for the staff account is requested.""" STAFF_SET_PASSWORD_REQUESTED - """ - Transaction item metadata is updated. - - Added in Saleor 3.8. - """ + """Transaction item metadata is updated.""" TRANSACTION_ITEM_METADATA_UPDATED """A new translation is created.""" @@ -2263,11 +2187,7 @@ enum WebhookEventTypeEnum @doc(category: "Webhooks") { """A warehouse is deleted.""" WAREHOUSE_DELETED - """ - A warehouse metadata is updated. - - Added in Saleor 3.8. - """ + """A warehouse metadata is updated.""" WAREHOUSE_METADATA_UPDATED """A new voucher created.""" @@ -2281,16 +2201,12 @@ enum WebhookEventTypeEnum @doc(category: "Webhooks") { VOUCHER_CODES_CREATED VOUCHER_CODES_DELETED - """ - A voucher metadata is updated. - - Added in Saleor 3.8. - """ + """A voucher metadata is updated.""" VOUCHER_METADATA_UPDATED """ A voucher code export is completed. - + Added in Saleor 3.18. """ VOUCHER_CODE_EXPORT_COMPLETED @@ -2298,18 +2214,10 @@ enum WebhookEventTypeEnum @doc(category: "Webhooks") { """An observability event is created.""" OBSERVABILITY - """ - A thumbnail is created. - - Added in Saleor 3.12. - """ + """A thumbnail is created.""" THUMBNAIL_CREATED - """ - Shop metadata is updated. - - Added in Saleor 3.15. - """ + """Shop metadata is updated.""" SHOP_METADATA_UPDATED """Listing available payment gateways.""" @@ -2333,45 +2241,19 @@ enum WebhookEventTypeEnum @doc(category: "Webhooks") { """Process payment.""" PAYMENT_PROCESS - """ - Event called for checkout tax calculation. - - Added in Saleor 3.6. - """ + """Event called for checkout tax calculation.""" CHECKOUT_CALCULATE_TAXES - """ - Event called for order tax calculation. - - Added in Saleor 3.6. - """ + """Event called for order tax calculation.""" ORDER_CALCULATE_TAXES - """ - Event called when charge has been requested for transaction. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Event called when charge has been requested for transaction.""" TRANSACTION_CHARGE_REQUESTED - """ - Event called when refund has been requested for transaction. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Event called when refund has been requested for transaction.""" TRANSACTION_REFUND_REQUESTED - """ - Event called when cancel has been requested for transaction. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Event called when cancel has been requested for transaction.""" TRANSACTION_CANCELATION_REQUESTED """Fetch external shipping methods for checkout.""" @@ -2424,45 +2306,19 @@ enum WebhookEventTypeSyncEnum @doc(category: "Webhooks") { """Process payment.""" PAYMENT_PROCESS - """ - Event called for checkout tax calculation. - - Added in Saleor 3.6. - """ + """Event called for checkout tax calculation.""" CHECKOUT_CALCULATE_TAXES - """ - Event called for order tax calculation. - - Added in Saleor 3.6. - """ + """Event called for order tax calculation.""" ORDER_CALCULATE_TAXES - """ - Event called when charge has been requested for transaction. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Event called when charge has been requested for transaction.""" TRANSACTION_CHARGE_REQUESTED - """ - Event called when refund has been requested for transaction. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Event called when refund has been requested for transaction.""" TRANSACTION_REFUND_REQUESTED - """ - Event called when cancel has been requested for transaction. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Event called when cancel has been requested for transaction.""" TRANSACTION_CANCELATION_REQUESTED """Fetch external shipping methods for checkout.""" @@ -2494,12 +2350,8 @@ type WebhookEventAsync @doc(category: "Webhooks") { """Enum determining type of webhook.""" enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") { - """ - All the events. - - DEPRECATED: this value will be removed in Saleor 4.0. - """ - ANY_EVENTS + """All the events.""" + ANY_EVENTS @deprecated """An account confirmation is requested.""" ACCOUNT_CONFIRMATION_REQUESTED @@ -2594,30 +2446,16 @@ enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") { """A gift card is deleted.""" GIFT_CARD_DELETED - """ - A gift card has been sent. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """A gift card has been sent.""" GIFT_CARD_SENT """A gift card status is changed.""" GIFT_CARD_STATUS_CHANGED - """ - A gift card metadata is updated. - - Added in Saleor 3.8. - """ + """A gift card metadata is updated.""" GIFT_CARD_METADATA_UPDATED - """ - A gift card export is completed. - - Added in Saleor 3.16. - """ + """A gift card export is completed.""" GIFT_CARD_EXPORT_COMPLETED """A new menu created.""" @@ -2646,13 +2484,7 @@ enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") { """ ORDER_CONFIRMED - """ - Payment has been made. The order may be partially or fully paid. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Payment has been made. The order may be partially or fully paid.""" ORDER_PAID """Payment is made and an order is fully paid.""" @@ -2660,20 +2492,10 @@ enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") { """ The order received a refund. The order may be partially or fully refunded. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ ORDER_REFUNDED - """ - The order is fully refunded. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """The order is fully refunded.""" ORDER_FULLY_REFUNDED """ @@ -2690,20 +2512,10 @@ enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") { """An order is fulfilled.""" ORDER_FULFILLED - """ - An order metadata is updated. - - Added in Saleor 3.8. - """ + """An order metadata is updated.""" ORDER_METADATA_UPDATED - """ - Orders are imported. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Orders are imported.""" ORDER_BULK_CREATED """A new fulfillment is created.""" @@ -2715,11 +2527,7 @@ enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") { """A fulfillment is approved.""" FULFILLMENT_APPROVED - """ - A fulfillment metadata is updated. - - Added in Saleor 3.8. - """ + """A fulfillment metadata is updated.""" FULFILLMENT_METADATA_UPDATED FULFILLMENT_TRACKING_NUMBER_UPDATED @@ -2786,11 +2594,7 @@ enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") { """A customer account is deleted.""" CUSTOMER_DELETED - """ - A customer account metadata is updated. - - Added in Saleor 3.8. - """ + """A customer account metadata is updated.""" CUSTOMER_METADATA_UPDATED """A new collection is created.""" @@ -2802,11 +2606,7 @@ enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") { """A collection is deleted.""" COLLECTION_DELETED - """ - A collection metadata is updated. - - Added in Saleor 3.8. - """ + """A collection metadata is updated.""" COLLECTION_METADATA_UPDATED """A new product is created.""" @@ -2818,39 +2618,19 @@ enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") { """A product is deleted.""" PRODUCT_DELETED - """ - A product metadata is updated. - - Added in Saleor 3.8. - """ + """A product metadata is updated.""" PRODUCT_METADATA_UPDATED - """ - A product export is completed. - - Added in Saleor 3.16. - """ + """A product export is completed.""" PRODUCT_EXPORT_COMPLETED - """ - A new product media is created. - - Added in Saleor 3.12. - """ + """A new product media is created.""" PRODUCT_MEDIA_CREATED - """ - A product media is updated. - - Added in Saleor 3.12. - """ + """A product media is updated.""" PRODUCT_MEDIA_UPDATED - """ - A product media is deleted. - - Added in Saleor 3.12. - """ + """A product media is deleted.""" PRODUCT_MEDIA_DELETED """A new product variant is created.""" @@ -2864,11 +2644,7 @@ enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") { """ PRODUCT_VARIANT_DELETED - """ - A product variant metadata is updated. - - Added in Saleor 3.8. - """ + """A product variant metadata is updated.""" PRODUCT_VARIANT_METADATA_UPDATED """A product variant is out of stock.""" @@ -2887,21 +2663,26 @@ enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") { A checkout is updated. It also triggers all updates related to the checkout. """ CHECKOUT_UPDATED - CHECKOUT_FULLY_PAID """ - A checkout metadata is updated. - - Added in Saleor 3.8. + A checkout was fully authorized (its `authorizeStatus` is `FULL`). + + This event is emitted only for checkouts whose payments are processed through the Transaction API. """ - CHECKOUT_METADATA_UPDATED + CHECKOUT_FULLY_AUTHORIZED """ - User notification triggered. - - DEPRECATED: this value will be removed in Saleor 4.0. See the docs for more details about migrating from NOTIFY_USER to other events: https://docs.saleor.io/docs/next/upgrade-guides/notify-user-deprecation + A checkout was fully paid (its `chargeStatus` is `FULL` or `OVERCHARGED`). This event is not sent if payments are only authorized but not fully charged. + + This event is emitted only for checkouts whose payments are processed through the Transaction API. """ - NOTIFY_USER + CHECKOUT_FULLY_PAID + + """A checkout metadata is updated.""" + CHECKOUT_METADATA_UPDATED + + """User notification triggered.""" + NOTIFY_USER @deprecated(reason: "See the docs for more details about migrating from NOTIFY_USER to other events: https://docs.saleor.io/upgrade-guides/core/3-16-to-3-17#migrating-from-notify_user") """A new page is created.""" PAGE_CREATED @@ -2948,11 +2729,7 @@ enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") { """A shipping zone is deleted.""" SHIPPING_ZONE_DELETED - """ - A shipping zone metadata is updated. - - Added in Saleor 3.8. - """ + """A shipping zone metadata is updated.""" SHIPPING_ZONE_METADATA_UPDATED """A new staff user is created.""" @@ -2967,11 +2744,7 @@ enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") { """Setting a new password for the staff account is requested.""" STAFF_SET_PASSWORD_REQUESTED - """ - Transaction item metadata is updated. - - Added in Saleor 3.8. - """ + """Transaction item metadata is updated.""" TRANSACTION_ITEM_METADATA_UPDATED """A new translation is created.""" @@ -2989,11 +2762,7 @@ enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") { """A warehouse is deleted.""" WAREHOUSE_DELETED - """ - A warehouse metadata is updated. - - Added in Saleor 3.8. - """ + """A warehouse metadata is updated.""" WAREHOUSE_METADATA_UPDATED """A new voucher created.""" @@ -3007,16 +2776,12 @@ enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") { VOUCHER_CODES_CREATED VOUCHER_CODES_DELETED - """ - A voucher metadata is updated. - - Added in Saleor 3.8. - """ + """A voucher metadata is updated.""" VOUCHER_METADATA_UPDATED """ A voucher code export is completed. - + Added in Saleor 3.18. """ VOUCHER_CODE_EXPORT_COMPLETED @@ -3024,18 +2789,10 @@ enum WebhookEventTypeAsyncEnum @doc(category: "Webhooks") { """An observability event is created.""" OBSERVABILITY - """ - A thumbnail is created. - - Added in Saleor 3.12. - """ + """A thumbnail is created.""" THUMBNAIL_CREATED - """ - Shop metadata is updated. - - Added in Saleor 3.15. - """ + """Shop metadata is updated.""" SHOP_METADATA_UPDATED } @@ -3049,17 +2806,13 @@ type App implements Node & ObjectWithMetadata @doc(category: "Apps") { """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -3068,23 +2821,19 @@ type App implements Node & ObjectWithMetadata @doc(category: "Apps") { """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata """ Canonical app ID from the manifest - + Added in Saleor 3.19. """ identifier: String @@ -3106,14 +2855,14 @@ type App implements Node & ObjectWithMetadata @doc(category: "Apps") { """ Last 4 characters of the tokens. - + Requires one of the following permissions: MANAGE_APPS, OWNER. """ tokens: [AppToken!] """ List of webhooks assigned to this app. - + Requires one of the following permissions: MANAGE_APPS, OWNER. """ webhooks: [Webhook!] @@ -3122,7 +2871,7 @@ type App implements Node & ObjectWithMetadata @doc(category: "Apps") { aboutApp: String """Description of the data privacy defined for this app.""" - dataPrivacy: String @deprecated(reason: "This field will be removed in Saleor 4.0. Use `dataPrivacyUrl` instead.") + dataPrivacy: String @deprecated(reason: "Use `dataPrivacyUrl` instead.") """URL to details about the privacy policy on the app owner page.""" dataPrivacyUrl: String @@ -3134,16 +2883,12 @@ type App implements Node & ObjectWithMetadata @doc(category: "Apps") { supportUrl: String """URL to iframe with the configuration for the app.""" - configurationUrl: String @deprecated(reason: "This field will be removed in Saleor 4.0. Use `appUrl` instead.") + configurationUrl: String @deprecated(reason: "Use `appUrl` instead.") """URL to iframe with the app.""" appUrl: String - """ - URL to manifest used during app's installation. - - Added in Saleor 3.5. - """ + """URL to manifest used during app's installation.""" manifestUrl: String """Version number of the app.""" @@ -3152,30 +2897,28 @@ type App implements Node & ObjectWithMetadata @doc(category: "Apps") { """JWT token used to authenticate by third-party app.""" accessToken: String - """ - The App's author name. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """The App's author name.""" author: String + """App's dashboard extensions.""" + extensions: [AppExtension!]! + + """App's brand data.""" + brand: AppBrand + """ - App's dashboard extensions. - - Added in Saleor 3.1. + Circuit breaker state, if open, sync webhooks operation is disrupted. + + Added in Saleor 3.21. """ - extensions: [AppExtension!]! + breakerState: CircuitBreakerStateEnum! """ - App's brand data. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. + Circuit breaker last state change date. + + Added in Saleor 3.21. """ - brand: AppBrand + breakerLastStateChange: DateTime } interface ObjectWithMetadata { @@ -3184,7 +2927,7 @@ interface ObjectWithMetadata { """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. """ privateMetafield(key: String!): String @@ -3199,7 +2942,7 @@ interface ObjectWithMetadata { """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. """ metafield(key: String!): String @@ -3240,7 +2983,6 @@ type Permission @doc(category: "Authentication") { name: String! } -"""An enumeration.""" enum PermissionEnum @doc(category: "Users") { MANAGE_USERS MANAGE_STAFF @@ -3315,26 +3057,67 @@ type AppExtension implements Node @doc(category: "Apps") { url: String! """Place where given extension will be mounted.""" - mount: AppExtensionMountEnum! + mount: AppExtensionMountEnum! @deprecated(reason: "Use `mountName` instead.") """Type of way how app extension will be opened.""" - target: AppExtensionTargetEnum! + target: AppExtensionTargetEnum! @deprecated(reason: "Use `targetName` instead.") + + """ + Name of the extension mount point in the dashboard. Replaces `mount` + + Added in Saleor 3.22. + """ + mountName: String! + + """ + Name of the extension target in the dashboard. Replaces `target` + + Added in Saleor 3.22. + """ + targetName: String! + + """ + App extension settings. Replaces `options` field. + + Added in Saleor 3.22. + """ + settings: JSON! """The app assigned to app extension.""" app: App! """JWT token used to authenticate by third-party app extension.""" accessToken: String + + """ + App extension options. + + Added in Saleor 3.22. + """ + options: AppExtensionPossibleOptions @deprecated(reason: "Use `settings` field instead.") } """All places where app extension can be mounted.""" enum AppExtensionMountEnum @doc(category: "Apps") { + CATEGORY_OVERVIEW_CREATE + CATEGORY_OVERVIEW_MORE_ACTIONS + CATEGORY_DETAILS_MORE_ACTIONS + COLLECTION_OVERVIEW_CREATE + COLLECTION_OVERVIEW_MORE_ACTIONS + COLLECTION_DETAILS_MORE_ACTIONS + COLLECTION_DETAILS_WIDGETS + GIFT_CARD_OVERVIEW_CREATE + GIFT_CARD_OVERVIEW_MORE_ACTIONS + GIFT_CARD_DETAILS_MORE_ACTIONS + GIFT_CARD_DETAILS_WIDGETS CUSTOMER_OVERVIEW_CREATE CUSTOMER_OVERVIEW_MORE_ACTIONS CUSTOMER_DETAILS_MORE_ACTIONS + CUSTOMER_DETAILS_WIDGETS PRODUCT_OVERVIEW_CREATE PRODUCT_OVERVIEW_MORE_ACTIONS PRODUCT_DETAILS_MORE_ACTIONS + PRODUCT_DETAILS_WIDGETS NAVIGATION_CATALOG NAVIGATION_ORDERS NAVIGATION_CUSTOMERS @@ -3344,6 +3127,28 @@ enum AppExtensionMountEnum @doc(category: "Apps") { ORDER_DETAILS_MORE_ACTIONS ORDER_OVERVIEW_CREATE ORDER_OVERVIEW_MORE_ACTIONS + ORDER_DETAILS_WIDGETS + DRAFT_ORDER_DETAILS_MORE_ACTIONS + DRAFT_ORDER_OVERVIEW_CREATE + DRAFT_ORDER_OVERVIEW_MORE_ACTIONS + DRAFT_ORDER_DETAILS_WIDGETS + DISCOUNT_DETAILS_MORE_ACTIONS + DISCOUNT_OVERVIEW_CREATE + DISCOUNT_OVERVIEW_MORE_ACTIONS + VOUCHER_DETAILS_MORE_ACTIONS + VOUCHER_OVERVIEW_CREATE + VOUCHER_OVERVIEW_MORE_ACTIONS + VOUCHER_DETAILS_WIDGETS + PAGE_DETAILS_MORE_ACTIONS + PAGE_OVERVIEW_CREATE + PAGE_OVERVIEW_MORE_ACTIONS + PAGE_TYPE_OVERVIEW_CREATE + PAGE_TYPE_OVERVIEW_MORE_ACTIONS + PAGE_TYPE_DETAILS_MORE_ACTIONS + MENU_OVERVIEW_CREATE + MENU_OVERVIEW_MORE_ACTIONS + MENU_DETAILS_MORE_ACTIONS + TRANSLATIONS_MORE_ACTIONS } """ @@ -3355,41 +3160,52 @@ All available ways of opening an app extension. enum AppExtensionTargetEnum @doc(category: "Apps") { POPUP APP_PAGE + NEW_TAB + WIDGET } -""" -Represents the app's brand data. +scalar JSON -Added in Saleor 3.14. +union AppExtensionPossibleOptions = AppExtensionOptionsWidget | AppExtensionOptionsNewTab -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" -type AppBrand @doc(category: "Apps") { - """ - App's logos details. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ - logo: AppBrandLogo! +"""Represents the options for an app extension.""" +type AppExtensionOptionsWidget @doc(category: "Apps") { + """Options for displaying a Widget""" + widgetTarget: WidgetTargetOptions @deprecated(reason: "Use `settings` field directly.") } -""" -Represents the app's brand logo data. +"""Represents the WIDGET target options for an app extension.""" +type WidgetTargetOptions @doc(category: "Apps") { + """HTTP method for Widget target (GET or POST)""" + method: HttpMethod! @deprecated(reason: "Use `settings` field directly.") +} + +enum HttpMethod { + POST + GET +} -Added in Saleor 3.14. +"""Represents the options for an app extension.""" +type AppExtensionOptionsNewTab @doc(category: "Apps") { + """Options controlling behavior of the NEW_TAB extension target""" + newTabTarget: NewTabTargetOptions @deprecated(reason: "Use `settings` field directly.") +} -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Represents the NEW_TAB target options for an app extension.""" +type NewTabTargetOptions @doc(category: "Apps") { + """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. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """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). @@ -3398,10 +3214,6 @@ type AppBrandLogo @doc(category: "Apps") { """ The format of the image. When not provided, format of the original image will be used. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ format: IconThumbnailFormatEnum = ORIGINAL ): String! @@ -3413,6 +3225,22 @@ enum IconThumbnailFormatEnum { WEBP } +"""Enum determining the state of a circuit breaker.""" +enum CircuitBreakerStateEnum @doc(category: "Apps") { + """The breaker is conducting (requests are passing through).""" + CLOSED + + """ + 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. + """ + HALF_OPEN + + """ + The breaker is tripped (no requests are passing). Breaker will enter half-open state after cooldown period. + """ + OPEN +} + type EventDeliveryCountableConnection { """Pagination data for this connection.""" pageInfo: PageInfo! @@ -3581,7 +3409,6 @@ input EventDeliveryFilterInput { scalar JSONString -"""An enumeration.""" enum WebhookSampleEventTypeEnum @doc(category: "Webhooks") { ACCOUNT_CONFIRMATION_REQUESTED ACCOUNT_CHANGE_EMAIL_REQUESTED @@ -3684,6 +3511,7 @@ enum WebhookSampleEventTypeEnum @doc(category: "Webhooks") { PRODUCT_VARIANT_STOCK_UPDATED CHECKOUT_CREATED CHECKOUT_UPDATED + CHECKOUT_FULLY_AUTHORIZED CHECKOUT_FULLY_PAID CHECKOUT_METADATA_UPDATED NOTIFY_USER @@ -3736,17 +3564,13 @@ type Warehouse implements Node & ObjectWithMetadata @doc(category: "Products") { """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -3755,17 +3579,13 @@ type Warehouse implements Node & ObjectWithMetadata @doc(category: "Products") { """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata @@ -3785,13 +3605,9 @@ type Warehouse implements Node & ObjectWithMetadata @doc(category: "Products") { address: Address! """Warehouse company name.""" - companyName: String! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `Address.companyName` instead.") + companyName: String! @deprecated(reason: "Use `Address.companyName` instead.") - """ - Click and collect options: local, all or disabled. - - Added in Saleor 3.1. - """ + """Click and collect options: local, all or disabled.""" clickAndCollectOption: WarehouseClickAndCollectOptionEnum! """Shipping zones supported by the warehouse.""" @@ -3815,9 +3631,9 @@ type Warehouse implements Node & ObjectWithMetadata @doc(category: "Products") { """ Stocks that belong to this warehouse. - + Added in Saleor 3.20. - + Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS. """ stocks( @@ -3838,11 +3654,7 @@ type Warehouse implements Node & ObjectWithMetadata @doc(category: "Products") { last: Int ): StockCountableConnection - """ - External ID of this warehouse. - - Added in Saleor 3.10. - """ + """External ID of this warehouse.""" externalReference: String } @@ -3851,49 +3663,33 @@ type Address implements Node & ObjectWithMetadata @doc(category: "Users") { """The ID of the address.""" id: ID! - """ - List of private metadata items. Requires staff permissions to access. - - Added in Saleor 3.10. - """ + """List of private metadata items. Requires staff permissions to access.""" privateMetadata: [MetadataItem!]! """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.10. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.10. """ privateMetafields(keys: [String!]): Metadata - """ - List of public metadata items. Can be accessed without permissions. - - Added in Saleor 3.10. - """ + """List of public metadata items. Can be accessed without permissions.""" metadata: [MetadataItem!]! """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.10. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.10. """ metafields(keys: [String!]): Metadata @@ -3945,7 +3741,7 @@ type CountryDisplay { country: String! """Country tax.""" - vat: VAT @deprecated(reason: "This field will be removed in Saleor 4.0. Always returns `null`. Use `TaxClassCountryRate` type to manage tax rates per country.") + vat: VAT @deprecated(reason: "Always returns `null`. Use `TaxClassCountryRate` type to manage tax rates per country.") } """Represents a VAT rate for a country.""" @@ -3969,7 +3765,6 @@ type ReducedRate @doc(category: "Taxes") { rateType: String! } -"""An enumeration.""" enum WarehouseClickAndCollectOptionEnum @doc(category: "Products") { DISABLED LOCAL @@ -4005,17 +3800,13 @@ type ShippingZone implements Node & ObjectWithMetadata @doc(category: "Shipping" """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -4024,17 +3815,13 @@ type ShippingZone implements Node & ObjectWithMetadata @doc(category: "Shipping" """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata @@ -4081,6 +3868,14 @@ type Money { """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! } """ @@ -4095,17 +3890,13 @@ type ShippingMethodType implements Node & ObjectWithMetadata @doc(category: "Shi """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -4114,17 +3905,13 @@ type ShippingMethodType implements Node & ObjectWithMetadata @doc(category: "Shi """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata @@ -4133,7 +3920,7 @@ type ShippingMethodType implements Node & ObjectWithMetadata @doc(category: "Shi """ Shipping method description. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString @@ -4149,7 +3936,7 @@ type ShippingMethodType implements Node & ObjectWithMetadata @doc(category: "Shi """ List of channels available for the method. - + Requires one of the following permissions: MANAGE_SHIPPING. """ channelListings: [ShippingMethodChannelListing!] @@ -4167,7 +3954,7 @@ type ShippingMethodType implements Node & ObjectWithMetadata @doc(category: "Shi """ List of excluded products for the shipping method. - + Requires one of the following permissions: MANAGE_SHIPPING. """ excludedProducts( @@ -4202,13 +3989,12 @@ type ShippingMethodType implements Node & ObjectWithMetadata @doc(category: "Shi """ Tax class assigned to this shipping method. - + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. """ taxClass: TaxClass } -"""An enumeration.""" enum ShippingMethodTypeEnum @doc(category: "Shipping") { PRICE WEIGHT @@ -4227,16 +4013,12 @@ type ShippingMethodTranslation implements Node @doc(category: "Shipping") { """ Translated description of the shipping method. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString - """ - Represents the shipping method fields to translate. - - Added in Saleor 3.14. - """ + """Represents the shipping method fields to translate.""" translatableContent: ShippingMethodTranslatableContent } @@ -4248,7 +4030,6 @@ type LanguageDisplay { language: String! } -"""An enumeration.""" enum LanguageCodeEnum { AF AF_NA @@ -5038,11 +4819,7 @@ type ShippingMethodTranslatableContent implements Node @doc(category: "Shipping" """The ID of the shipping method translatable content.""" id: ID! - """ - The ID of the shipping method to translate. - - Added in Saleor 3.14. - """ + """The ID of the shipping method to translate.""" shippingMethodId: ID! """Shipping method name to translate.""" @@ -5050,7 +4827,7 @@ type ShippingMethodTranslatableContent implements Node @doc(category: "Shipping" """ Shipping method description to translate. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString @@ -5063,10 +4840,10 @@ type ShippingMethodTranslatableContent implements Node @doc(category: "Shipping" """ Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers. - + Requires one of the following permissions: MANAGE_SHIPPING. """ - shippingMethod: ShippingMethodType @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.") + shippingMethod: ShippingMethodType @deprecated(reason: "Get model fields from the root level queries.") } """Represents shipping method channel listing.""" @@ -5092,49 +4869,33 @@ type Channel implements Node & ObjectWithMetadata @doc(category: "Channels") { """The ID of the channel.""" id: ID! - """ - List of private metadata items. Requires staff permissions to access. - - Added in Saleor 3.15. - """ + """List of private metadata items. Requires staff permissions to access.""" privateMetadata: [MetadataItem!]! """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.15. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.15. """ privateMetafields(keys: [String!]): Metadata - """ - List of public metadata items. Can be accessed without permissions. - - Added in Saleor 3.15. - """ + """List of public metadata items. Can be accessed without permissions.""" metadata: [MetadataItem!]! """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.15. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.15. """ metafields(keys: [String!]): Metadata @@ -5143,119 +4904,91 @@ type Channel implements Node & ObjectWithMetadata @doc(category: "Channels") { """ Name of the channel. - + Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. """ name: String! """ Whether the channel is active. - + Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. """ isActive: Boolean! """ A currency that is assigned to the channel. - + Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. """ currencyCode: String! """ Whether a channel has associated orders. - + Requires one of the following permissions: MANAGE_CHANNELS. """ hasOrders: Boolean! """ Default country for the channel. Default country can be used in checkout to determine the stock quantities or calculate taxes when the country was not explicitly provided. - - Added in Saleor 3.1. - + Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. """ defaultCountry: CountryDisplay! """ List of warehouses assigned to this channel. - - Added in Saleor 3.5. - + Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. """ warehouses: [Warehouse!]! - """ - List of shippable countries for the channel. - - Added in Saleor 3.6. - """ + """List of shippable countries for the channel.""" countries: [CountryDisplay!] - """ - Shipping methods that are available for the channel. - - Added in Saleor 3.6. - """ + """Shipping methods that are available for the channel.""" availableShippingMethodsPerCountry(countries: [CountryCode!]): [ShippingMethodsPerCountry!] """ Define the stock setting for this channel. - - Added in Saleor 3.7. - + Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. """ stockSettings: StockSettings! """ Channel-specific order settings. - - Added in Saleor 3.12. - + Requires one of the following permissions: MANAGE_CHANNELS, MANAGE_ORDERS. """ orderSettings: OrderSettings! """ Channel-specific checkout settings. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_CHANNELS, MANAGE_CHECKOUTS. """ checkoutSettings: CheckoutSettings! """ Channel-specific payment settings. - - Added in Saleor 3.16. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_CHANNELS, 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! } -""" -List of shipping methods available for the country. - -Added in Saleor 3.6. -""" +"""List of shipping methods available for the country.""" type ShippingMethodsPerCountry @doc(category: "Shipping") { """The country code.""" countryCode: CountryCode! @@ -5389,6 +5122,7 @@ enum CountryCode { KZ KE KI + XK KW KG LA @@ -5534,7 +5268,7 @@ type ShippingMethod implements Node & ObjectWithMetadata @doc(category: "Shippin """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. """ privateMetafield(key: String!): String @@ -5549,7 +5283,7 @@ type ShippingMethod implements Node & ObjectWithMetadata @doc(category: "Shippin """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. """ metafield(key: String!): String @@ -5560,14 +5294,14 @@ type ShippingMethod implements Node & ObjectWithMetadata @doc(category: "Shippin metafields(keys: [String!]): Metadata """Type of the shipping method.""" - type: ShippingMethodTypeEnum @deprecated(reason: "This field will be removed in Saleor 4.0.") + type: ShippingMethodTypeEnum @deprecated """Shipping method name.""" name: String! """ Shipping method description. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString @@ -5579,10 +5313,10 @@ type ShippingMethod implements Node & ObjectWithMetadata @doc(category: "Shippin minimumDeliveryDays: Int """Maximum order weight for this shipping method.""" - maximumOrderWeight: Weight @deprecated(reason: "This field will be removed in Saleor 4.0.") + maximumOrderWeight: Weight @deprecated """Minimum order weight for this shipping method.""" - minimumOrderWeight: Weight @deprecated(reason: "This field will be removed in Saleor 4.0.") + minimumOrderWeight: Weight @deprecated """Returns translated shipping method fields for the given language code.""" translation( @@ -5615,7 +5349,6 @@ type Weight { value: Float! } -"""An enumeration.""" enum WeightUnitsEnum { G LB @@ -5624,11 +5357,7 @@ enum WeightUnitsEnum { TONNE } -""" -Represents the channel stock settings. - -Added in Saleor 3.7. -""" +"""Represents the channel stock settings.""" type StockSettings @doc(category: "Products") { """ Allocation strategy defines the preference of warehouses for allocations and reservations. @@ -5663,10 +5392,6 @@ type OrderSettings { """ Expiration time in minutes. Default null - means do not expire any orders. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ expireOrdersAfter: Minute @@ -5674,39 +5399,44 @@ type OrderSettings { Determine what strategy will be used to mark the order as paid. Based on the chosen option, the proper object will be created and attached to the order when it's manually marked as paid. `PAYMENT_FLOW` - [default option] creates the `Payment` object. `TRANSACTION_FLOW` - creates the `TransactionItem` object. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ markAsPaidStrategy: MarkAsPaidStrategyEnum! - """ - The time in days after expired orders will be deleted. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """The time in days after expired orders will be deleted.""" deleteExpiredOrdersAfter: Day! """ Determine if it is possible to place unpaid order by calling `checkoutComplete` mutation. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ allowUnpaidOrders: Boolean! """ 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! + + """ + 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 + + """ + 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. + """ + useLegacyLineDiscountPropagation: Boolean! } """ @@ -5731,32 +5461,65 @@ enum MarkAsPaidStrategyEnum @doc(category: "Channels") { """The `Day` scalar type represents number of days by integer value.""" scalar Day -""" -Represents the channel-specific checkout settings. - -Added in Saleor 3.15. +"""The `Hour` scalar type represents number of hours by integer value.""" +scalar Hour -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""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. - - Added in Saleor 3.15.This field will be removed in Saleor 4.0. """ useLegacyErrorFlow: Boolean! -} -"""Represents the channel-specific payment settings.""" -type PaymentSettings { + """ + 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! + + """ + The time in minutes to wait after a checkout is fully paid before automatically completing it. + + Added in Saleor 3.22. + """ + automaticCompletionDelay: Minute + + """ + 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 { """ Determine the transaction flow strategy to be used. Include the selected option in the payload sent to the payment app, as a requested action for the transaction. - - Added in Saleor 3.16. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ defaultTransactionFlowStrategy: TransactionFlowStrategyEnum! + + """ + Determine if the funds for expired checkouts should be released automatically. + + Added in Saleor 3.20. + """ + releaseFundsForExpiredCheckouts: Boolean + + """ + The time in hours after which funds for expired checkouts will be released. + + Added in Saleor 3.20. + """ + checkoutTtlBeforeReleasingFunds: Hour + + """ + 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 } """ @@ -5770,11 +5533,7 @@ enum TransactionFlowStrategyEnum @doc(category: "Payments") { CHARGE } -""" -Channel-specific tax configuration. - -Added in Saleor 3.9. -""" +"""Channel-specific tax configuration.""" type TaxConfiguration implements Node & ObjectWithMetadata @doc(category: "Taxes") { """The ID of the object.""" id: ID! @@ -5784,17 +5543,13 @@ type TaxConfiguration implements Node & ObjectWithMetadata @doc(category: "Taxes """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -5803,17 +5558,13 @@ type TaxConfiguration implements Node & ObjectWithMetadata @doc(category: "Taxes """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata @@ -5839,10 +5590,17 @@ type TaxConfiguration implements Node & ObjectWithMetadata @doc(category: "Taxes """ 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 + + """ + 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 } enum TaxCalculationStrategy @doc(category: "Taxes") { @@ -5850,11 +5608,7 @@ enum TaxCalculationStrategy @doc(category: "Taxes") { TAX_APP } -""" -Country-specific exceptions of a channel's tax configuration. - -Added in Saleor 3.9. -""" +"""Country-specific exceptions of a channel's tax configuration.""" type TaxConfigurationPerCountry @doc(category: "Taxes") { """Country in which this configuration applies.""" country: CountryDisplay! @@ -5874,10 +5628,17 @@ type TaxConfigurationPerCountry @doc(category: "Taxes") { """ 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. """ taxAppId: String + + """ + 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 } """Represents shipping method postal code rule.""" @@ -5895,7 +5656,6 @@ type ShippingMethodPostalCodeRule implements Node @doc(category: "Shipping") { inclusionType: PostalCodeRuleInclusionTypeEnum } -"""An enumeration.""" enum PostalCodeRuleInclusionTypeEnum @doc(category: "Shipping") { INCLUDE EXCLUDE @@ -5919,7 +5679,7 @@ type ProductCountableEdge @doc(category: "Products") { } """Represents an individual item for sale in the storefront.""" -type Product implements Node & ObjectWithMetadata @doc(category: "Products") { +type Product implements Node & ObjectWithMetadata & ObjectWithAttributes @doc(category: "Products") { """The ID of the product.""" id: ID! @@ -5928,17 +5688,13 @@ type Product implements Node & ObjectWithMetadata @doc(category: "Products") { """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -5947,20 +5703,36 @@ type Product implements Node & ObjectWithMetadata @doc(category: "Products") { """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ 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 @@ -5972,7 +5744,7 @@ type Product implements Node & ObjectWithMetadata @doc(category: "Products") { """ Description of the product. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString @@ -5989,7 +5761,7 @@ type Product implements Node & ObjectWithMetadata @doc(category: "Products") { """The date and time when the product was last updated.""" updatedAt: DateTime! - chargeTaxes: Boolean! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` field to determine whether tax collection is enabled.") + chargeTaxes: Boolean! @deprecated(reason: "Use `Channel.taxConfiguration` field to determine whether tax collection is enabled.") """Weight of the product.""" weight: Weight @@ -6007,10 +5779,10 @@ type Product implements Node & ObjectWithMetadata @doc(category: "Products") { """ Description of the product. - + Rich text format. For reference see https://editorjs.io/ """ - descriptionJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `description` field instead.") + descriptionJson: JSONString @deprecated(reason: "Use the `description` field instead.") """Thumbnail of the product.""" thumbnail( @@ -6021,8 +5793,6 @@ type Product implements Node & ObjectWithMetadata @doc(category: "Products") { """ The format of the image. When not provided, format of the original image will be used. - - Added in Saleor 3.6. """ format: ThumbnailFormatEnum = ORIGINAL ): Image @@ -6048,24 +5818,20 @@ type Product implements Node & ObjectWithMetadata @doc(category: "Products") { ): Boolean """A type of tax. Assigned by enabled tax gateway""" - taxType: TaxType @deprecated(reason: "This field will be removed in Saleor 4.0. Use `taxClass` field instead.") + taxType: TaxType @deprecated(reason: "Use `taxClass` field instead.") - """ - Get a single attribute attached to product by attribute slug. - - Added in Saleor 3.9. - """ + """Get a single attribute attached to product by attribute slug.""" attribute( """Slug of the attribute""" slug: String! - ): SelectedAttribute + ): SelectedAttribute @deprecated(reason: "Use the `assignedAttribute` field instead.") """List of attributes assigned to this product.""" - attributes: [SelectedAttribute!]! + attributes: [SelectedAttribute!]! @deprecated(reason: "Use the `assignedAttributes` field instead.") """ List of availability in channels for the product. - + Requires one of the following permissions: MANAGE_PRODUCTS. """ channelListings: [ProductChannelListing!] @@ -6073,45 +5839,69 @@ type Product implements Node & ObjectWithMetadata @doc(category: "Products") { """Get a single product media by ID.""" mediaById( """ID of a product media.""" - id: ID + id: ID! ): ProductMedia """Get a single product image by ID.""" imageById( """ID of a product image.""" - id: ID - ): ProductImage @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `mediaById` field instead.") + id: ID! + ): ProductImage @deprecated(reason: "Use the `mediaById` field instead.") - """ - Get a single variant by SKU or ID. - - Added in Saleor 3.9. - """ + """Get a single variant by SKU or ID.""" variant( """ID of the variant.""" id: ID """SKU of the variant.""" sku: String - ): ProductVariant @deprecated(reason: "This field will be removed in Saleor 4.0. Use top-level `variant` query.") + ): ProductVariant @deprecated(reason: "Use top-level `variant` query.") """ List of variants for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. """ - variants: [ProductVariant!] + variants: [ProductVariant!] @deprecated(reason: "Use `productVariants` field instead.") + + """ + List of variants for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. + + Added in Saleor 3.21. + """ + productVariants( + """Filtering options for product variant.""" + filter: ProductVariantFilterInput @deprecated(reason: "Use `where` filter instead.") + + """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 - """List of media for the product.""" - media( """ - Sort media. - - Added in Saleor 3.9. + 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: "This field will be removed in Saleor 4.0. Use the `media` field instead.") + images: [ProductImage!] @deprecated(reason: "Use the `media` field instead.") """ List of collections for the product. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. @@ -6125,7 +5915,7 @@ type Product implements Node & ObjectWithMetadata @doc(category: "Products") { ): ProductTranslation """Date when product is available for purchase.""" - availableForPurchase: Date @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `availableForPurchaseAt` field to fetch the available for purchase date.") + availableForPurchase: Date @deprecated(reason: "Use the `availableForPurchaseAt` field to fetch the available for purchase date.") """Date when product is available for purchase.""" availableForPurchaseAt: DateTime @@ -6137,24 +5927,57 @@ type Product implements Node & ObjectWithMetadata @doc(category: "Products") { """ Tax class assigned to this product type. All products of this product type use this tax class, unless it's overridden in the `Product` type. - + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. """ taxClass: TaxClass + """External ID of this product.""" + externalReference: String +} + +""" +An object with attributes. + +Added in Saleor 3.22. +""" +interface ObjectWithAttributes @doc(category: "Attributes") { """ - External ID of this product. - - Added in Saleor 3.10. + Get a single attribute attached to the object by attribute slug. + + Added in Saleor 3.22. """ - externalReference: String + assignedAttribute( + """Slug of the attribute""" + slug: String! + ): AssignedAttribute @doc(category: "Attributes") + + """ + 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 a type of product. It defines what attributes are available to products of this type. +Represents an attribute assigned to an object. + +Added in Saleor 3.22. """ -type ProductType implements Node & ObjectWithMetadata @doc(category: "Products") { - """The ID of the product type.""" +interface AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! +} + +""" +Custom attribute of a product. Attributes can be assigned to products and variants at the product type level. +""" +type Attribute implements Node & ObjectWithMetadata @doc(category: "Attributes") { + """The ID of the attribute.""" id: ID! """List of private metadata items. Requires staff permissions to access.""" @@ -6162,17 +5985,13 @@ type ProductType implements Node & ObjectWithMetadata @doc(category: "Products") """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -6181,45 +6000,69 @@ type ProductType implements Node & ObjectWithMetadata @doc(category: "Products") """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata - """Name of the product type.""" - name: String! + """The input type to use for entering attribute values in the dashboard.""" + inputType: AttributeInputTypeEnum - """Slug of the product type.""" - slug: String! + """The entity type which can be used as a reference.""" + entityType: AttributeEntityTypeEnum - """Whether the product type has variants.""" - hasVariants: Boolean! + """ + The reference types (product or page type) that are used to narrow down the choices of reference objects. - """Whether shipping is required for this product type.""" - isShippingRequired: Boolean! + 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!] - """Whether the product type is digital.""" - isDigital: Boolean! + """Name of an attribute displayed in the interface.""" + name: String - """Weight of the product type.""" - weight: Weight + """Internal representation of an attribute name.""" + slug: String - """The product type kind.""" - kind: ProductTypeKindEnum! + """The attribute type.""" + type: AttributeTypeEnum - """List of products of this type.""" - products( - """Slug of a channel for which the data should be returned.""" - channel: String + """The unit of attribute values.""" + unit: MeasurementUnitsEnum + + """ + A list of predefined attribute choices available for selection. Available only for attributes with predefined choices. + """ + choices( + """Sort attribute choices.""" + sortBy: AttributeChoicesSortingInput + + """Filtering options for attribute choices.""" + filter: AttributeValueFilterInput @deprecated(reason: "Use `where` filter instead.") + + """ + Where filtering options for attribute choices. + + Added in Saleor 3.22. + """ + where: AttributeValueWhereInput + + """ + Search attribute choices. + + Added in Saleor 3.22. + """ + search: String """Return the elements in the list that come before the specified cursor.""" before: String @@ -6236,46 +6079,51 @@ 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: "This field will be removed in Saleor 4.0. Use the top-level `products` query with the `productTypes` filter.") + ): AttributeValueCountableConnection - """A type of tax. Assigned by enabled tax gateway""" - taxType: TaxType @deprecated(reason: "This field will be removed in Saleor 4.0. Use `taxClass` field instead.") + """ + Whether the attribute requires values to be passed or not. Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES, MANAGE_PRODUCTS, MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. + """ + valueRequired: Boolean! """ - 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. + 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. """ - taxClass: TaxClass + visibleInStorefront: Boolean! - """Variant attributes of that product type.""" - variantAttributes( - """Define scope of returned attributes.""" - variantSelection: VariantAttributeScope - ): [Attribute!] @deprecated(reason: "This field will be removed in Saleor 4.0. Use `assignedVariantAttributes` instead.") + """ + Whether the attribute can be filtered in storefront. Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES, MANAGE_PRODUCTS, MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. + """ + filterableInStorefront: Boolean! @deprecated """ - Variant attributes of that product type with attached variant selection. - - Added in Saleor 3.1. + 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. """ - assignedVariantAttributes( - """Define scope of returned attributes.""" - variantSelection: VariantAttributeScope - ): [AssignedVariantAttribute!] + filterableInDashboard: Boolean! - """Product attributes of that product type.""" - productAttributes: [Attribute!] + """ + Whether the attribute can be displayed in the admin product list. Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES, MANAGE_PRODUCTS, MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. + """ + availableInGrid: Boolean! @deprecated """ - List of attributes which can be assigned to this product type. - - Requires one of the following permissions: MANAGE_PRODUCTS. + 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. """ - availableAttributes( - filter: AttributeFilterInput - where: AttributeWhereInput + storefrontSearchPosition: Int! @deprecated + + """Returns translated attribute fields for the given language code.""" + translation( + """A language code to return the translation for attribute.""" + languageCode: LanguageCodeEnum! + ): AttributeTranslation + """Flag indicating that attribute has predefined choices.""" + withChoices: Boolean! + + """ + 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 @@ -6291,99 +6139,68 @@ 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 -} + ): ProductTypeCountableConnection! -"""An enumeration.""" -enum ProductTypeKindEnum @doc(category: "Products") { - NORMAL - GIFT_CARD -} + """ + 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 -"""Representation of tax types fetched from tax gateway.""" -type TaxType @doc(category: "Taxes") { - """Description of the tax type.""" - description: String + """Return the elements in the list that come after the specified cursor.""" + after: String - """External tax code used to identify given tax group.""" - taxCode: String -} - -""" -Tax class is a named object used to define tax rates per country. Tax class can be assigned to product types, products and shipping methods to define their tax rates. - -Added in Saleor 3.9. -""" -type TaxClass implements Node & ObjectWithMetadata @doc(category: "Taxes") { - """The ID of the object.""" - id: ID! - - """List of private metadata items. Requires staff permissions to access.""" - privateMetadata: [MetadataItem!]! - - """ - A single key from private metadata. Requires staff permissions to access. - - Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. - """ - privateMetafield(key: String!): String - - """ - Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. - """ - privateMetafields(keys: [String!]): Metadata - - """List of public metadata items. Can be accessed without permissions.""" - metadata: [MetadataItem!]! + """ + 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 single key from public metadata. - - Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. - """ - metafield(key: String!): 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! - """ - Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. - """ - metafields(keys: [String!]): Metadata + """External ID of this attribute.""" + externalReference: String +} - """Name of the tax class.""" - name: String! +enum AttributeInputTypeEnum @doc(category: "Attributes") { + DROPDOWN + MULTISELECT + FILE + REFERENCE + SINGLE_REFERENCE + NUMERIC + RICH_TEXT + PLAIN_TEXT + SWATCH + BOOLEAN + DATE + DATE_TIME +} - """Country-specific tax rates for this tax class.""" - countries: [TaxClassCountryRate!]! +enum AttributeEntityTypeEnum @doc(category: "Attributes") { + PAGE + PRODUCT + PRODUCT_VARIANT + CATEGORY + COLLECTION } """ -Tax rate for a country. When tax class is null, it represents the default tax rate for that country; otherwise it's a country tax rate specific to the given tax class. - -Added in Saleor 3.9. +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. """ -type TaxClassCountryRate @doc(category: "Taxes") { - """Country in which this tax rate applies.""" - country: CountryDisplay! - - """Tax rate value.""" - rate: Float! - - """Related tax class.""" - taxClass: TaxClass -} +union ReferenceType = ProductType | PageType """ -Custom attribute of a product. Attributes can be assigned to products and variants at the product type level. +Represents a type of product. It defines what attributes are available to products of this type. """ -type Attribute implements Node & ObjectWithMetadata @doc(category: "Attributes") { - """The ID of the attribute.""" +type ProductType implements Node & ObjectWithMetadata @doc(category: "Products") { + """The ID of the product type.""" id: ID! """List of private metadata items. Requires staff permissions to access.""" @@ -6391,17 +6208,13 @@ type Attribute implements Node & ObjectWithMetadata @doc(category: "Attributes") """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -6410,45 +6223,41 @@ type Attribute implements Node & ObjectWithMetadata @doc(category: "Attributes") """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata - """The input type to use for entering attribute values in the dashboard.""" - inputType: AttributeInputTypeEnum + """Name of the product type.""" + name: String! - """The entity type which can be used as a reference.""" - entityType: AttributeEntityTypeEnum + """Slug of the product type.""" + slug: String! - """Name of an attribute displayed in the interface.""" - name: String + """Whether the product type has variants.""" + hasVariants: Boolean! - """Internal representation of an attribute name.""" - slug: String + """Whether shipping is required for this product type.""" + isShippingRequired: Boolean! - """The attribute type.""" - type: AttributeTypeEnum + """Whether the product type is digital.""" + isDigital: Boolean! - """The unit of attribute values.""" - unit: MeasurementUnitsEnum + """Weight of the product type.""" + weight: Weight - """List of attribute's values.""" - choices( - """Sort attribute choices.""" - sortBy: AttributeChoicesSortingInput + """The product type kind.""" + kind: ProductTypeKindEnum! - """Filtering options for attribute choices.""" - filter: AttributeValueFilterInput + """List of products of this type.""" + products( + """Slug of a channel for which the data should be returned.""" + channel: String """Return the elements in the list that come before the specified cursor.""" before: String @@ -6465,51 +6274,50 @@ 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 + ): ProductCountableConnection @deprecated(reason: "Use the top-level `products` query with the `productTypes` filter.") - """ - Whether the attribute requires values to be passed or not. Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES, MANAGE_PRODUCTS, MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. - """ - valueRequired: Boolean! + """A type of tax. Assigned by enabled tax gateway""" + taxType: TaxType @deprecated(reason: "Use `taxClass` field instead.") """ - Whether the attribute should be visible or not in storefront. Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES, MANAGE_PRODUCTS, MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. - """ - visibleInStorefront: Boolean! + 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. """ - Whether the attribute can be filtered in storefront. Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES, MANAGE_PRODUCTS, MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. - """ - filterableInStorefront: Boolean! @deprecated(reason: "This field will be removed in Saleor 4.0.") + taxClass: TaxClass - """ - Whether the attribute can be filtered in dashboard. Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES, MANAGE_PRODUCTS, MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. - """ - filterableInDashboard: Boolean! + """Variant attributes of that product type.""" + variantAttributes( + """Define scope of returned attributes.""" + variantSelection: VariantAttributeScope + ): [Attribute!] @deprecated(reason: "Use `assignedVariantAttributes` instead.") """ - 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. + Variant attributes of that product type with attached variant selection. """ - availableInGrid: Boolean! @deprecated(reason: "This field will be removed in Saleor 4.0.") + assignedVariantAttributes( + """Define scope of returned attributes.""" + variantSelection: VariantAttributeScope + ): [AssignedVariantAttribute!] + + """Product attributes of that product type.""" + productAttributes: [Attribute!] """ - 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. + List of attributes which can be assigned to this product type. + + Requires one of the following permissions: MANAGE_PRODUCTS. """ - storefrontSearchPosition: Int! @deprecated(reason: "This field will be removed in Saleor 4.0.") + availableAttributes( + """Filtering options for attributes of this product type.""" + filter: AttributeFilterInput @deprecated(reason: "Use `where` filter instead.") - """Returns translated attribute fields for the given language code.""" - translation( - """A language code to return the translation for attribute.""" - languageCode: LanguageCodeEnum! - ): AttributeTranslation + """Where filtering options for attributes of this product type.""" + where: AttributeWhereInput - """Flag indicating that attribute has predefined choices.""" - withChoices: Boolean! + """Search attributes.""" + search: String - """ - 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 @@ -6525,66 +6333,214 @@ 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 - ): ProductTypeCountableConnection! + ): AttributeCountableConnection +} + +enum ProductTypeKindEnum @doc(category: "Products") { + NORMAL + GIFT_CARD +} + +"""Representation of tax types fetched from tax gateway.""" +type TaxType @doc(category: "Taxes") { + """Description of the tax type.""" + description: String + + """External tax code used to identify given tax group.""" + taxCode: String +} + +""" +Tax class is a named object used to define tax rates per country. Tax class can be assigned to product types, products and shipping methods to define their tax rates. +""" +type TaxClass implements Node & ObjectWithMetadata @doc(category: "Taxes") { + """The ID of the object.""" + id: ID! + + """List of private metadata items. Requires staff permissions to access.""" + privateMetadata: [MetadataItem!]! """ - A list of product types that use this attribute as a product variant attribute. + A single key from private metadata. Requires staff permissions to access. + + Tip: Use GraphQL aliases to fetch multiple keys. """ - productVariantTypes( - """Return the elements in the list that come before the specified cursor.""" - before: String + privateMetafield(key: String!): String - """Return the elements in the list that come after the specified cursor.""" - after: 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 - """ - 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 public metadata items. Can be accessed without permissions.""" + metadata: [MetadataItem!]! - """ - 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! + """ + A single key from public metadata. + Tip: Use GraphQL aliases to fetch multiple keys. """ - External ID of this attribute. - - Added in Saleor 3.10. + metafield(key: String!): String + """ - externalReference: String -} + Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. + """ + metafields(keys: [String!]): Metadata -"""An enumeration.""" -enum AttributeInputTypeEnum @doc(category: "Attributes") { - DROPDOWN - MULTISELECT - FILE - REFERENCE - NUMERIC - RICH_TEXT - PLAIN_TEXT - SWATCH - BOOLEAN - DATE - DATE_TIME + """Name of the tax class.""" + name: String! + + """Country-specific tax rates for this tax class.""" + countries: [TaxClassCountryRate!]! } -"""An enumeration.""" -enum AttributeEntityTypeEnum @doc(category: "Attributes") { - PAGE - PRODUCT - PRODUCT_VARIANT +""" +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! + + """Tax rate value.""" + rate: Float! + + """Related tax class.""" + taxClass: TaxClass +} + +enum VariantAttributeScope @doc(category: "Products") { + ALL + VARIANT_SELECTION + NOT_VARIANT_SELECTION +} + +""" +Represents assigned attribute to variant with variant selection attached. +""" +type AssignedVariantAttribute @doc(category: "Attributes") { + """Attribute assigned to variant.""" + attribute: Attribute! + + """ + Determines, whether assigned attribute is allowed for variant selection. Supported variant types for variant selection are: ['dropdown', 'boolean', 'swatch', 'numeric'] + """ + variantSelection: Boolean! +} + +type AttributeCountableConnection @doc(category: "Attributes") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [AttributeCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type AttributeCountableEdge @doc(category: "Attributes") { + """The item at the end of the edge.""" + node: Attribute! + + """A cursor for use in pagination.""" + cursor: String! +} + +input AttributeFilterInput @doc(category: "Attributes") { + valueRequired: Boolean + isVariantOnly: Boolean + visibleInStorefront: Boolean + filterableInStorefront: Boolean + filterableInDashboard: Boolean + availableInGrid: Boolean + metadata: [MetadataFilter!] + search: String + ids: [ID!] + type: AttributeTypeEnum + inCollection: ID + inCategory: ID + slugs: [String!] + + """Specifies the channel by which the data should be filtered.""" + channel: String @deprecated(reason: "Use root-level channel argument instead.") +} + +input MetadataFilter { + """Key of a metadata item.""" + key: String! + + """Value of a metadata item.""" + value: String } -"""An enumeration.""" enum AttributeTypeEnum @doc(category: "Attributes") { PRODUCT_TYPE PAGE_TYPE } -"""An enumeration.""" +"""Where filtering options.""" +input AttributeWhereInput @doc(category: "Attributes") { + 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 + + """List of conditions that must be met.""" + AND: [AttributeWhereInput!] + + """A list of conditions of which at least one must be met.""" + OR: [AttributeWhereInput!] +} + +"""Define the filtering options for string fields.""" +input StringFilterInput { + """The value equal to.""" + eq: String + + """The value included in.""" + oneOf: [String!] +} + +input AttributeInputTypeEnumFilterInput @doc(category: "Attributes") { + """The value equal to.""" + eq: AttributeInputTypeEnum + + """The value included in.""" + oneOf: [AttributeInputTypeEnum!] +} + +input AttributeEntityTypeEnumFilterInput @doc(category: "Attributes") { + """The value equal to.""" + eq: AttributeEntityTypeEnum + + """The value included in.""" + oneOf: [AttributeEntityTypeEnum!] +} + +input AttributeTypeEnumFilterInput @doc(category: "Attributes") { + """The value equal to.""" + eq: AttributeTypeEnum + + """The value included in.""" + oneOf: [AttributeTypeEnum!] +} + +input MeasurementUnitsEnumFilterInput @doc(category: "Attributes") { + """The value equal to.""" + eq: MeasurementUnitsEnum + + """The value included in.""" + oneOf: [MeasurementUnitsEnum!] +} + enum MeasurementUnitsEnum { MM CM @@ -6622,6 +6578,99 @@ enum MeasurementUnitsEnum { TONNE } +""" +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! + + """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 + + """Name of the page type.""" + name: String! + + """Slug of the page type.""" + slug: String! + + """Page attributes of that page type.""" + attributes: [Attribute!] + + """ + Attributes that can be assigned to the page type. + + Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES. + """ + availableAttributes( + """Filtering options for attributes.""" + filter: AttributeFilterInput @deprecated(reason: "Use `where` filter instead.") + + """Where filtering options for attributes.""" + where: AttributeWhereInput + + """Search attributes.""" + search: String + + """Return the elements in the list that come before the specified cursor.""" + before: String + + """Return the elements in the list that come after the specified cursor.""" + after: String + + """ + Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + first: Int + + """ + Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. + """ + last: Int + ): AttributeCountableConnection + + """ + Whether page type has pages assigned. + + Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES. + """ + hasPages: Boolean +} + +""" +Positive Integer scalar implementation. + +Should be used in places where value must be positive (greater than 0). +""" +scalar PositiveInt + type AttributeValueCountableConnection @doc(category: "Attributes") { """Pagination data for this connection.""" pageInfo: PageInfo! @@ -6664,7 +6713,7 @@ type AttributeValue implements Node @doc(category: "Attributes") { """The input type to use for entering attribute values in the dashboard.""" inputType: AttributeInputTypeEnum - """The ID of the attribute reference.""" + """The ID of the referenced object.""" reference: ID """Represents file URL and content type (if attribute value is a file).""" @@ -6672,7 +6721,7 @@ type AttributeValue implements Node @doc(category: "Attributes") { """ Represents the text of the attribute value, includes formatting. - + Rich text format. For reference see https://editorjs.io/ """ richText: JSONString @@ -6691,11 +6740,7 @@ type AttributeValue implements Node @doc(category: "Attributes") { """Represents the date/time value of the attribute value.""" dateTime: DateTime - """ - External ID of this attribute value. - - Added in Saleor 3.10. - """ + """External ID of this attribute value.""" externalReference: String } @@ -6712,7 +6757,7 @@ type AttributeValueTranslation implements Node @doc(category: "Attributes") { """ Translated rich-text attribute value. - + Rich text format. For reference see https://editorjs.io/ """ richText: JSONString @@ -6720,11 +6765,7 @@ type AttributeValueTranslation implements Node @doc(category: "Attributes") { """Translated plain text attribute value .""" plainText: String - """ - Represents the attribute value fields to translate. - - Added in Saleor 3.14. - """ + """Represents the attribute value fields to translate.""" translatableContent: AttributeValueTranslatableContent } @@ -6735,11 +6776,7 @@ type AttributeValueTranslatableContent implements Node @doc(category: "Attribute """The ID of the attribute value translatable content.""" id: ID! - """ - The ID of the attribute value to translate. - - Added in Saleor 3.14. - """ + """The ID of the attribute value to translate.""" attributeValueId: ID! """Name of the attribute value to translate.""" @@ -6747,7 +6784,7 @@ type AttributeValueTranslatableContent implements Node @doc(category: "Attribute """ Attribute value. - + Rich text format. For reference see https://editorjs.io/ """ richText: JSONString @@ -6762,13 +6799,9 @@ type AttributeValueTranslatableContent implements Node @doc(category: "Attribute ): AttributeValueTranslation """Represents a value of an attribute.""" - attributeValue: AttributeValue @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.") + attributeValue: AttributeValue @deprecated(reason: "Get model fields from the root level queries.") - """ - Associated attribute that can be translated. - - Added in Saleor 3.9. - """ + """Associated attribute that can be translated.""" attribute: AttributeTranslatableContent } @@ -6779,11 +6812,7 @@ type AttributeTranslatableContent implements Node @doc(category: "Attributes") { """The ID of the attribute translatable content.""" id: ID! - """ - The ID of the attribute to translate. - - Added in Saleor 3.14. - """ + """The ID of the attribute to translate.""" attributeId: ID! """Name of the attribute to translate.""" @@ -6796,7 +6825,7 @@ type AttributeTranslatableContent implements Node @doc(category: "Attributes") { ): AttributeTranslation """Custom attribute of a product.""" - attribute: Attribute @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.") + attribute: Attribute @deprecated(reason: "Get model fields from the root level queries.") } """Represents attribute translations.""" @@ -6810,11 +6839,7 @@ type AttributeTranslation implements Node @doc(category: "Attributes") { """Translated attribute name.""" name: String! - """ - Represents the attribute fields to translate. - - Added in Saleor 3.14. - """ + """Represents the attribute fields to translate.""" translatableContent: AttributeTranslatableContent } @@ -6855,6 +6880,19 @@ input AttributeValueFilterInput @doc(category: "Attributes") { slugs: [String!] } +"""Where filtering options for attribute values.""" +input AttributeValueWhereInput @doc(category: "Attributes") { + 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 @doc(category: "Products") { """Pagination data for this connection.""" pageInfo: PageInfo! @@ -6872,152 +6910,6 @@ type ProductTypeCountableEdge @doc(category: "Products") { cursor: String! } -enum VariantAttributeScope @doc(category: "Products") { - ALL - VARIANT_SELECTION - NOT_VARIANT_SELECTION -} - -""" -Represents assigned attribute to variant with variant selection attached. - -Added in Saleor 3.1. -""" -type AssignedVariantAttribute @doc(category: "Attributes") { - """Attribute assigned to variant.""" - attribute: Attribute! - - """ - Determines, whether assigned attribute is allowed for variant selection. Supported variant types for variant selection are: ['dropdown', 'boolean', 'swatch', 'numeric'] - """ - variantSelection: Boolean! -} - -type AttributeCountableConnection @doc(category: "Attributes") { - """Pagination data for this connection.""" - pageInfo: PageInfo! - edges: [AttributeCountableEdge!]! - - """A total count of items in the collection.""" - totalCount: Int -} - -type AttributeCountableEdge @doc(category: "Attributes") { - """The item at the end of the edge.""" - node: Attribute! - - """A cursor for use in pagination.""" - cursor: String! -} - -input AttributeFilterInput @doc(category: "Attributes") { - valueRequired: Boolean - isVariantOnly: Boolean - visibleInStorefront: Boolean - filterableInStorefront: Boolean - filterableInDashboard: Boolean - availableInGrid: Boolean - metadata: [MetadataFilter!] - search: String - ids: [ID!] - type: AttributeTypeEnum - inCollection: ID - inCategory: ID - slugs: [String!] - - """ - Specifies the channel by which the data should be filtered. - - DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. - """ - channel: String -} - -input MetadataFilter { - """Key of a metadata item.""" - key: String! - - """Value of a metadata item.""" - value: String -} - -""" -Where filtering options. - -Added in Saleor 3.11. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" -input AttributeWhereInput @doc(category: "Attributes") { - 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 - - """List of conditions that must be met.""" - AND: [AttributeWhereInput!] - - """A list of conditions of which at least one must be met.""" - OR: [AttributeWhereInput!] -} - -""" -Define the filtering options for string fields. - -Added in Saleor 3.11. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" -input StringFilterInput { - """The value equal to.""" - eq: String - - """The value included in.""" - oneOf: [String!] -} - -input AttributeInputTypeEnumFilterInput @doc(category: "Attributes") { - """The value equal to.""" - eq: AttributeInputTypeEnum - - """The value included in.""" - oneOf: [AttributeInputTypeEnum!] -} - -input AttributeEntityTypeEnumFilterInput @doc(category: "Attributes") { - """The value equal to.""" - eq: AttributeEntityTypeEnum - - """The value included in.""" - oneOf: [AttributeEntityTypeEnum!] -} - -input AttributeTypeEnumFilterInput @doc(category: "Attributes") { - """The value equal to.""" - eq: AttributeTypeEnum - - """The value included in.""" - oneOf: [AttributeTypeEnum!] -} - -input MeasurementUnitsEnumFilterInput @doc(category: "Attributes") { - """The value equal to.""" - eq: MeasurementUnitsEnum - - """The value included in.""" - oneOf: [MeasurementUnitsEnum!] -} - """ Represents a single category of products. Categories allow to organize products in a tree-hierarchies which can be used for navigation in the storefront. """ @@ -7030,17 +6922,13 @@ type Category implements Node & ObjectWithMetadata @doc(category: "Products") { """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -7049,17 +6937,13 @@ type Category implements Node & ObjectWithMetadata @doc(category: "Products") { """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata @@ -7074,7 +6958,7 @@ type Category implements Node & ObjectWithMetadata @doc(category: "Products") { """ Description of the category. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString @@ -7090,16 +6974,12 @@ type Category implements Node & ObjectWithMetadata @doc(category: "Products") { """ Description of the category. - + Rich text format. For reference see https://editorjs.io/ """ - descriptionJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `description` field instead.") + descriptionJson: JSONString @deprecated(reason: "Use the `description` field instead.") - """ - The date and time when the category was last updated. - - Added in Saleor 3.17. - """ + """The date and time when the category was last updated.""" updatedAt: DateTime! """List of ancestors of the category.""" @@ -7125,29 +7005,18 @@ type Category implements Node & ObjectWithMetadata @doc(category: "Products") { List of products in the category. Requires the following permissions to include the unpublished items: MANAGE_ORDERS, MANAGE_DISCOUNTS, MANAGE_PRODUCTS. """ products( - """ - Filtering options for products. - - Added in Saleor 3.10. - """ - filter: ProductFilterInput + """Filtering options for products.""" + filter: ProductFilterInput @deprecated(reason: "Use `where` filter instead.") - """ - Filtering options for products. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Where filtering options for products.""" where: ProductWhereInput - """ - Sort products. - - Added in Saleor 3.10. - """ + """Sort products.""" sortBy: ProductOrder + """Search products.""" + search: String + """Slug of a channel for which the data should be returned.""" channel: String @@ -7196,8 +7065,6 @@ type Category implements Node & ObjectWithMetadata @doc(category: "Products") { """ The format of the image. When not provided, format of the original image will be used. - - Added in Saleor 3.6. """ format: ThumbnailFormatEnum = ORIGINAL ): Image @@ -7239,32 +7106,16 @@ input ProductFilterInput @doc(category: "Products") { search: String metadata: [MetadataFilter!] - """ - Filter by the publication date. - - Added in Saleor 3.8. - """ + """Filter by the publication date.""" publishedFrom: DateTime - """ - Filter by availability for purchase. - - Added in Saleor 3.8. - """ + """Filter by availability for purchase.""" isAvailable: Boolean - """ - Filter by the date of availability for purchase. - - Added in Saleor 3.8. - """ + """Filter by the date of availability for purchase.""" availableFrom: DateTime - """ - Filter by visibility in product listings. - - Added in Saleor 3.8. - """ + """Filter by visibility in product listings.""" isVisibleInListing: Boolean price: PriceRangeInput @@ -7281,50 +7132,92 @@ input ProductFilterInput @doc(category: "Products") { hasPreorderedVariants: Boolean slugs: [String!] - """ - Specifies the channel by which the data should be filtered. - - DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. - """ - channel: String + """Specifies the channel by which the data should be filtered.""" + channel: String @deprecated(reason: "Use root-level channel argument instead.") } input AttributeInput @doc(category: "Attributes") { """Internal representation of an attribute name.""" - slug: String! + slug: String - """Internal representation of a value (unique per attribute).""" - values: [String!] + """ + 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 range that the returned values should be in.""" - valuesRange: IntRangeInput + """ + 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. + """ + values: [String!] @deprecated(reason: "Use `value` instead.") - """The date/time range that the returned values should be in.""" - dateTime: DateTimeRangeInput + """ + The range that the returned values should be in. Requires `slug` to be provided. + """ + valuesRange: IntRangeInput @deprecated(reason: "Use `value` instead.") + + """ + The date/time range that the returned values should be in. Requires `slug` to be provided. + """ + dateTime: DateTimeRangeInput @deprecated(reason: "Use `value` instead.") """ - 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. + 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. """ + date: DateRangeInput @deprecated(reason: "Use `value` instead.") + + """The boolean value of the attribute. Requires `slug` to be provided.""" + boolean: Boolean @deprecated(reason: "Use `value` instead.") +} + +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 - """The boolean value of the attribute.""" + """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 } -input IntRangeInput { - """Value greater than or equal to.""" - gte: Int +"""Define the filtering options for decimal fields.""" +input DecimalFilterInput { + """The value equal to.""" + eq: Decimal - """Value less than or equal to.""" - lte: Int + """The value included in.""" + oneOf: [Decimal!] + + """The value in range.""" + range: DecimalRangeInput } -input DateTimeRangeInput { - """Start date.""" - gte: DateTime +""" +Custom Decimal implementation. - """End date.""" - lte: DateTime +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 { @@ -7335,6 +7228,65 @@ input DateRangeInput { 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 @@ -7421,13 +7373,7 @@ input ProductWhereInput @doc(category: "Products") { OR: [ProductWhereInput!] } -""" -Define the filtering options for foreign key fields. - -Added in Saleor 3.14. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Define the filtering options for foreign key fields.""" input GlobalIDFilterInput { """The value equal to.""" eq: ID @@ -7436,47 +7382,7 @@ input GlobalIDFilterInput { oneOf: [ID!] } -""" -Define the filtering options for decimal fields. - -Added in Saleor 3.14. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" -input DecimalFilterInput { - """The value equal to.""" - eq: Decimal - - """The value included in.""" - oneOf: [Decimal!] - - """The value in range.""" - range: DecimalRangeInput -} - -""" -Custom Decimal implementation. - -Returns Decimal as a float in the API, -parses float to the Decimal on the way back. -""" -scalar Decimal - -input DecimalRangeInput { - """Decimal value greater than or equal to.""" - gte: Decimal - - """Decimal value less than or equal to.""" - lte: Decimal -} - -""" -Define the filtering options for date time fields. - -Added in Saleor 3.11. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Define the filtering options for date time fields.""" input DateTimeFilterInput { """The value equal to.""" eq: DateTime @@ -7492,12 +7398,8 @@ input ProductOrder @doc(category: "Products") { """Specifies the direction in which to sort products.""" direction: OrderDirection! - """ - Specifies the channel in which to sort the data. - - DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. - """ - channel: String + """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. @@ -7520,44 +7422,44 @@ enum ProductOrderField @doc(category: "Products") { """ 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 + LAST_MODIFIED @deprecated(reason: "Use `LAST_MODIFIED_AT` instead.") """Sort products by update date.""" - 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 + 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 @@ -7567,7 +7469,7 @@ enum ProductOrderField @doc(category: "Products") { """ 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 @@ -7575,11 +7477,7 @@ enum ProductOrderField @doc(category: "Products") { """Sort products by rating.""" RATING - """ - Sort products by creation date. - - Added in Saleor 3.8. - """ + """Sort products by creation date.""" CREATED_AT } @@ -7592,7 +7490,6 @@ type Image { alt: String } -"""An enumeration.""" enum ThumbnailFormatEnum { ORIGINAL AVIF @@ -7613,28 +7510,31 @@ type CategoryTranslation implements Node @doc(category: "Products") { """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: "This field will be removed in Saleor 4.0. Use the `description` field instead.") + descriptionJson: JSONString @deprecated(reason: "Use the `description` field instead.") - """ - Represents the category fields to translate. - - Added in Saleor 3.14. - """ + """Represents the category fields to translate.""" translatableContent: CategoryTranslatableContent } @@ -7645,11 +7545,7 @@ type CategoryTranslatableContent implements Node @doc(category: "Products") { """The ID of the category translatable content.""" id: ID! - """ - The ID of the category to translate. - - Added in Saleor 3.14. - """ + """The ID of the category to translate.""" categoryId: ID! """SEO title to translate.""" @@ -7658,22 +7554,29 @@ type CategoryTranslatableContent implements Node @doc(category: "Products") { """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: "This field will be removed in Saleor 4.0. Use the `description` field instead.") + descriptionJson: JSONString @deprecated(reason: "Use the `description` field instead.") """Returns translated category fields for the given language code.""" translation( @@ -7682,11 +7585,11 @@ type CategoryTranslatableContent implements Node @doc(category: "Products") { ): CategoryTranslation """Represents a single category of products.""" - category: Category @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.") + 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 @doc(category: "Products") { +type ProductVariant implements Node & ObjectWithMetadata & ObjectWithAttributes @doc(category: "Products") { """The ID of the product variant.""" id: ID! @@ -7695,17 +7598,13 @@ type ProductVariant implements Node & ObjectWithMetadata @doc(category: "Product """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -7714,20 +7613,36 @@ type ProductVariant implements Node & ObjectWithMetadata @doc(category: "Product """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ 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! @@ -7755,7 +7670,7 @@ type ProductVariant implements Node & ObjectWithMetadata @doc(category: "Product """ List of price information in channels for the product. - + Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. """ channelListings: [ProductVariantChannelListing!] @@ -7774,27 +7689,27 @@ type ProductVariant implements Node & ObjectWithMetadata @doc(category: "Product attributes( """Define scope of returned attributes.""" variantSelection: VariantAttributeScope - ): [SelectedAttribute!]! + ): [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: "This field will be removed in Saleor 4.0. Use the `media` field instead.") + images: [ProductImage!] @deprecated(reason: "Use the `media` field instead.") """List of media for the product variant.""" media: [ProductMedia!] @@ -7807,14 +7722,14 @@ type ProductVariant implements Node & ObjectWithMetadata @doc(category: "Product """ 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( @@ -7823,12 +7738,8 @@ type ProductVariant implements Node & ObjectWithMetadata @doc(category: "Product """ address: AddressInput - """ - Two-letter ISO 3166-1 country code. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `address` argument instead. - """ - countryCode: CountryCode + """Two-letter ISO 3166-1 country code.""" + countryCode: CountryCode @deprecated(reason: "Use `address` argument instead.") ): [Stock!] """ @@ -7841,18 +7752,12 @@ type ProductVariant implements Node & ObjectWithMetadata @doc(category: "Product address: AddressInput """ - Two-letter ISO 3166-1 country code. When provided, the exact quantity from a warehouse operating in shipping zones that contain this country will be returned. Otherwise, it will return the maximum quantity from all shipping zones. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `address` argument instead. + 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 + countryCode: CountryCode @deprecated(reason: "Use `address` argument instead.") ): Int - """ - Preorder data for product variant. - - Added in Saleor 3.1. - """ + """Preorder data for product variant.""" preorder: PreorderData """The date and time when the product variant was created.""" @@ -7861,11 +7766,7 @@ type ProductVariant implements Node & ObjectWithMetadata @doc(category: "Product """The date and time when the product variant was last updated.""" updatedAt: DateTime! - """ - External ID of this product. - - Added in Saleor 3.10. - """ + """External ID of this product.""" externalReference: String } @@ -7883,18 +7784,21 @@ type ProductVariantChannelListing implements Node @doc(category: "Products") { """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. - - Added in Saleor 3.1. - """ + """Preorder variant data.""" preorderThreshold: PreorderThreshold } @@ -7915,8 +7819,15 @@ type VariantPricingInfo @doc(category: "Products") { """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: "This field will be removed in Saleor 4.0. Always returns `null`.") + discountLocalCurrency: TaxedMoney @deprecated(reason: "Always returns `null`.") """The price, with any discount subtracted.""" price: TaxedMoney @@ -7924,8 +7835,15 @@ type VariantPricingInfo @doc(category: "Products") { """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: "This field will be removed in Saleor 4.0. Always returns `null`.") + priceLocalCurrency: TaxedMoney @deprecated(reason: "Always returns `null`.") } """ @@ -7978,23 +7896,23 @@ input AddressInput { """ Phone number. - + Phone numbers are validated with Google's [libphonenumber](https://github.com/google/libphonenumber) library. """ phone: String """ - Address public metadata. - - Added in Saleor 3.15. + Address public metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ Determine if the address should be validated. By default, Saleor accepts only address inputs matching ruleset from [Google Address Data]{https://chromium-i18n.appspot.com/ssl-address), using [i18naddress](https://github.com/mirumee/google-i18n-address) library. Some mutations may require additional permissions to use the the field. More info about permissions can be found in relevant mutation. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ skipValidation: Boolean = false @@ -8008,7 +7926,7 @@ input MetadataInput { value: String! } -"""Represents a custom attribute.""" +"""Represents an assigned attribute to an object.""" type SelectedAttribute @doc(category: "Attributes") { """Name of an attribute displayed in the interface.""" attribute: Attribute! @@ -8044,8 +7962,6 @@ type ProductImage @doc(category: "Products") { """ The format of the image. When not provided, format of the original image will be used. - - Added in Saleor 3.6. """ format: ThumbnailFormatEnum = ORIGINAL ): String! @@ -8056,49 +7972,33 @@ type ProductMedia implements Node & ObjectWithMetadata @doc(category: "Products" """The unique ID of the product media.""" id: ID! - """ - List of private metadata items. Requires staff permissions to access. - - Added in Saleor 3.12. - """ + """List of private metadata items. Requires staff permissions to access.""" privateMetadata: [MetadataItem!]! """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.12. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.12. """ privateMetafields(keys: [String!]): Metadata - """ - List of public metadata items. Can be accessed without permissions. - - Added in Saleor 3.12. - """ + """List of public metadata items. Can be accessed without permissions.""" metadata: [MetadataItem!]! """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.12. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.12. """ metafields(keys: [String!]): Metadata @@ -8123,21 +8023,14 @@ type ProductMedia implements Node & ObjectWithMetadata @doc(category: "Products" """ The format of the image. When not provided, format of the original image will be used. - - Added in Saleor 3.6. """ format: ThumbnailFormatEnum = ORIGINAL ): String! - """ - Product id the media refers to. - - Added in Saleor 3.12. - """ + """Product id the media refers to.""" productId: ID } -"""An enumeration.""" enum ProductMediaType @doc(category: "Products") { IMAGE VIDEO @@ -8154,11 +8047,7 @@ type ProductVariantTranslation implements Node @doc(category: "Products") { """Translated product variant name.""" name: String! - """ - Represents the product variant fields to translate. - - Added in Saleor 3.14. - """ + """Represents the product variant fields to translate.""" translatableContent: ProductVariantTranslatableContent } @@ -8169,11 +8058,7 @@ type ProductVariantTranslatableContent implements Node @doc(category: "Products" """The ID of the product variant translatable content.""" id: ID! - """ - The ID of the product variant to translate. - - Added in Saleor 3.14. - """ + """The ID of the product variant to translate.""" productVariantId: ID! """Name of the product variant to translate.""" @@ -8186,7 +8071,7 @@ type ProductVariantTranslatableContent implements Node @doc(category: "Products" ): ProductVariantTranslation """Represents a version of a product such as different size or color.""" - productVariant: ProductVariant @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.") + productVariant: ProductVariant @deprecated(reason: "Get model fields from the root level queries.") """List of product variant attribute values that can be translated.""" attributeValues: [AttributeValueTranslatableContent!]! @@ -8202,17 +8087,13 @@ type DigitalContent implements Node & ObjectWithMetadata @doc(category: "Product """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -8221,17 +8102,13 @@ type DigitalContent implements Node & ObjectWithMetadata @doc(category: "Product """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata @@ -8293,21 +8170,21 @@ type Stock implements Node @doc(category: "Products") { """ Quantity of a product in the warehouse's possession, including the allocated stock that is waiting for shipment. - + Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS. """ quantity: Int! """ Quantity allocated for orders. - + Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS. """ quantityAllocated: Int! """ Quantity reserved for checkouts. - + Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS. """ quantityReserved: Int! @@ -8317,14 +8194,14 @@ type Stock implements Node @doc(category: "Products") { type PreorderData @doc(category: "Products") { """ The global preorder threshold for product variant. - + Requires one of the following permissions: MANAGE_PRODUCTS. """ globalThreshold: Int """ Total number of sold product variant during preorder. - + Requires one of the following permissions: MANAGE_PRODUCTS. """ globalSoldUnits: Int! @@ -8341,14 +8218,17 @@ type ProductPricingInfo @doc(category: "Products") { """The discount amount if in sale (null otherwise).""" discount: TaxedMoney - """The discount amount in the local currency.""" - discountLocalCurrency: TaxedMoney @deprecated(reason: "This field will be removed in Saleor 4.0. Always returns `null`.") - """ - Determines whether displayed prices should include taxes. - - Added in Saleor 3.9. + 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`.") + + """Determines whether displayed prices should include taxes.""" displayGrossPrices: Boolean! """The discounted price range of the product variants.""" @@ -8357,10 +8237,17 @@ type ProductPricingInfo @doc(category: "Products") { """The undiscounted price range of the product variants.""" priceRangeUndiscounted: TaxedMoneyRange + """ + The prior price range of the product variants. + + Added in Saleor 3.21. + """ + priceRangePrior: TaxedMoneyRange + """ The discounted price range of the product variants in the local currency. """ - priceRangeLocalCurrency: TaxedMoneyRange @deprecated(reason: "This field will be removed in Saleor 4.0. Always returns `null`.") + priceRangeLocalCurrency: TaxedMoneyRange @deprecated(reason: "Always returns `null`.") } """Represents a range of monetary values.""" @@ -8376,13 +8263,9 @@ type TaxedMoneyRange { type ProductChannelListing implements Node @doc(category: "Products") { """The ID of the product channel listing.""" id: ID! - publicationDate: Date @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `publishedAt` field to fetch the publication date.") + publicationDate: Date @deprecated(reason: "Use the `publishedAt` field to fetch the publication date.") - """ - The product publication date time. - - Added in Saleor 3.3. - """ + """The product publication date time.""" publishedAt: DateTime """Indicates if the product is published in the channel.""" @@ -8393,13 +8276,9 @@ type ProductChannelListing implements Node @doc(category: "Products") { """Indicates product visibility in the channel listings.""" visibleInListings: Boolean! - availableForPurchase: Date @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `availableForPurchaseAt` field to fetch the available for purchase date.") + availableForPurchase: Date @deprecated(reason: "Use the `availableForPurchaseAt` field to fetch the available for purchase date.") - """ - The product available for purchase date time. - - Added in Saleor 3.3. - """ + """The product available for purchase date time.""" availableForPurchaseAt: DateTime """The price of the cheapest variant (including discounts).""" @@ -8407,14 +8286,14 @@ type ProductChannelListing implements Node @doc(category: "Products") { """ Purchase cost of product. - + Requires one of the following permissions: MANAGE_PRODUCTS. """ purchaseCost: MoneyRange """ Range of margin percentage value. - + Requires one of the following permissions: MANAGE_PRODUCTS. """ margin: Margin @@ -8444,6 +8323,78 @@ type Margin @doc(category: "Products") { stop: Int } +type ProductVariantCountableConnection @doc(category: "Products") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [ProductVariantCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type ProductVariantCountableEdge @doc(category: "Products") { + """The item at the end of the edge.""" + node: ProductVariant! + + """A cursor for use in pagination.""" + cursor: String! +} + +input ProductVariantFilterInput @doc(category: "Products") { + search: String + sku: [String!] + metadata: [MetadataFilter!] + isPreorder: Boolean + updatedAt: DateTimeRangeInput +} + +input ProductVariantWhereInput @doc(category: "Products") { + metadata: [MetadataFilter!] + ids: [ID!] + + """Filter by product SKU.""" + sku: StringFilterInput + + """Filter by when was the most recent update.""" + updatedAt: DateTimeRangeInput + + """ + Filter by attributes associated with the variant. + + Added in Saleor 3.22. + """ + attributes: [AssignedAttributeWhereInput!] + + """List of conditions that must be met.""" + AND: [ProductVariantWhereInput!] + + """A list of conditions of which at least one must be met.""" + OR: [ProductVariantWhereInput!] +} + +input AssignedAttributeWhereInput { + """Filter by attribute slug.""" + slug: String + + """ + Filter by value of the attribute. Only one value input field is allowed. If provided more than one, the error will be raised. + """ + value: AssignedAttributeValueInput +} + +input ProductVariantSortingInput @doc(category: "Products") { + """Specifies the direction in which to sort productVariants.""" + direction: OrderDirection! + + """Sort productVariants by the selected field.""" + field: ProductVariantSortField! +} + +enum ProductVariantSortField @doc(category: "Products") { + """Sort product variants by last modification date.""" + LAST_MODIFIED_AT +} + input MediaSortingInput @doc(category: "Products") { """Specifies the direction in which to sort media.""" direction: OrderDirection! @@ -8467,17 +8418,13 @@ type Collection implements Node & ObjectWithMetadata @doc(category: "Products") """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -8486,17 +8433,13 @@ type Collection implements Node & ObjectWithMetadata @doc(category: "Products") """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata @@ -8511,7 +8454,7 @@ type Collection implements Node & ObjectWithMetadata @doc(category: "Products") """ Description of the collection. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString @@ -8526,25 +8469,22 @@ type Collection implements Node & ObjectWithMetadata @doc(category: "Products") """ Description of the collection. - + Rich text format. For reference see https://editorjs.io/ """ - descriptionJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `description` field instead.") + descriptionJson: JSONString @deprecated(reason: "Use the `description` field instead.") """List of products in this collection.""" products( """Filtering options for products.""" - filter: ProductFilterInput + filter: ProductFilterInput @deprecated(reason: "Use `where` filter instead.") - """ - Filtering options for products. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Where filtering options for products.""" where: ProductWhereInput + """Search products.""" + search: String + """Sort products.""" sortBy: ProductOrder @@ -8574,8 +8514,6 @@ type Collection implements Node & ObjectWithMetadata @doc(category: "Products") """ The format of the image. When not provided, format of the original image will be used. - - Added in Saleor 3.6. """ format: ThumbnailFormatEnum = ORIGINAL ): Image @@ -8588,7 +8526,7 @@ type Collection implements Node & ObjectWithMetadata @doc(category: "Products") """ List of channels in which the collection is available. - + Requires one of the following permissions: MANAGE_PRODUCTS. """ channelListings: [CollectionChannelListing!] @@ -8608,28 +8546,31 @@ type CollectionTranslation implements Node @doc(category: "Products") { """Translated SEO description.""" seoDescription: String + """ + Translated collection slug. + + Added in Saleor 3.21. + """ + slug: String + """Translated collection name.""" name: String """ Translated description of the collection. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString """ Translated description of the collection. - + Rich text format. For reference see https://editorjs.io/ """ - descriptionJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `description` field instead.") + descriptionJson: JSONString @deprecated(reason: "Use the `description` field instead.") - """ - Represents the collection fields to translate. - - Added in Saleor 3.14. - """ + """Represents the collection fields to translate.""" translatableContent: CollectionTranslatableContent } @@ -8640,11 +8581,7 @@ type CollectionTranslatableContent implements Node @doc(category: "Products") { """The ID of the collection translatable content.""" id: ID! - """ - The ID of the collection to translate. - - Added in Saleor 3.14. - """ + """The ID of the collection to translate.""" collectionId: ID! """SEO title to translate.""" @@ -8653,22 +8590,29 @@ type CollectionTranslatableContent implements Node @doc(category: "Products") { """SEO description to translate.""" seoDescription: String + """ + Slug to translate + + Added in Saleor 3.21. + """ + slug: String + """Collection's name to translate.""" name: String! """ Collection's description to translate. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString """ Description of the collection. - + Rich text format. For reference see https://editorjs.io/ """ - descriptionJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `description` field instead.") + descriptionJson: JSONString @deprecated(reason: "Use the `description` field instead.") """Returns translated collection fields for the given language code.""" translation( @@ -8677,20 +8621,16 @@ type CollectionTranslatableContent implements Node @doc(category: "Products") { ): CollectionTranslation """Represents a collection of products.""" - collection: Collection @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.") + collection: Collection @deprecated(reason: "Get model fields from the root level queries.") } """Represents collection channel listing.""" type CollectionChannelListing implements Node @doc(category: "Products") { """The ID of the collection channel listing.""" id: ID! - publicationDate: Date @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `publishedAt` field to fetch the publication date.") + publicationDate: Date @deprecated(reason: "Use the `publishedAt` field to fetch the publication date.") - """ - The collection publication date. - - Added in Saleor 3.3. - """ + """The collection publication date.""" publishedAt: DateTime """Indicates if the collection is published in the channel.""" @@ -8714,28 +8654,31 @@ type ProductTranslation implements Node @doc(category: "Products") { """Translated SEO description.""" seoDescription: String + """ + Translated product slug. + + Added in Saleor 3.21. + """ + slug: String + """Translated product name.""" name: String """ Translated description of the product. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString """ Translated description of the product. - + Rich text format. For reference see https://editorjs.io/ """ - descriptionJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `description` field instead.") + descriptionJson: JSONString @deprecated(reason: "Use the `description` field instead.") - """ - Represents the product fields to translate. - - Added in Saleor 3.14. - """ + """Represents the product fields to translate.""" translatableContent: ProductTranslatableContent } @@ -8746,11 +8689,7 @@ type ProductTranslatableContent implements Node @doc(category: "Products") { """The ID of the product translatable content.""" id: ID! - """ - The ID of the product to translate. - - Added in Saleor 3.14. - """ + """The ID of the product to translate.""" productId: ID! """SEO title to translate.""" @@ -8759,22 +8698,29 @@ type ProductTranslatableContent implements Node @doc(category: "Products") { """SEO description to translate.""" seoDescription: String + """ + Slug to translate. + + Added in Saleor 3.21. + """ + slug: String + """Product's name to translate.""" name: String! """ Product's description to translate. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString """ Description of the product. - + Rich text format. For reference see https://editorjs.io/ """ - descriptionJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `description` field instead.") + descriptionJson: JSONString @deprecated(reason: "Use the `description` field instead.") """Returns translated product fields for the given language code.""" translation( @@ -8783,7 +8729,7 @@ type ProductTranslatableContent implements Node @doc(category: "Products") { ): ProductTranslation """Represents an individual item for sale in the storefront.""" - product: Product @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.") + product: Product @deprecated(reason: "Get model fields from the root level queries.") """List of product attribute values that can be translated.""" attributeValues: [AttributeValueTranslatableContent!]! @@ -8872,11 +8818,7 @@ type PageTranslatableContent implements Node @doc(category: "Pages") { """The ID of the page translatable content.""" id: ID! - """ - The ID of the page to translate. - - Added in Saleor 3.14. - """ + """The ID of the page to translate.""" pageId: ID! """SEO title to translate.""" @@ -8885,22 +8827,29 @@ type PageTranslatableContent implements Node @doc(category: "Pages") { """SEO description to translate.""" seoDescription: String + """ + Slug to translate. + + Added in Saleor 3.21. + """ + slug: String + """Page title to translate.""" title: String! """ Content of the page to translate. - + Rich text format. For reference see https://editorjs.io/ """ content: JSONString """ Content of the page. - + Rich text format. For reference see https://editorjs.io/ """ - contentJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `content` field instead.") + contentJson: JSONString @deprecated(reason: "Use the `content` field instead.") """Returns translated page fields for the given language code.""" translation( @@ -8911,7 +8860,7 @@ type PageTranslatableContent implements Node @doc(category: "Pages") { """ A static page that can be manually added by a shop operator through the dashboard. """ - page: Page @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.") + page: Page @deprecated(reason: "Get model fields from the root level queries.") """List of page content attribute values that can be translated.""" attributeValues: [AttributeValueTranslatableContent!]! @@ -8931,35 +8880,38 @@ type PageTranslation implements Node @doc(category: "Pages") { """Translated SEO description.""" seoDescription: String + """ + Translated page slug. + + Added in Saleor 3.21. + """ + slug: String + """Translated page title.""" title: String """ Translated content of the page. - + Rich text format. For reference see https://editorjs.io/ """ content: JSONString """ Translated description of the page. - + Rich text format. For reference see https://editorjs.io/ """ - contentJson: JSONString @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `content` field instead.") + contentJson: JSONString @deprecated(reason: "Use the `content` field instead.") - """ - Represents the page fields to translate. - - Added in Saleor 3.14. - """ + """Represents the page fields to translate.""" translatableContent: PageTranslatableContent } """ A static page that can be manually added by a shop operator through the dashboard. """ -type Page implements Node & ObjectWithMetadata @doc(category: "Pages") { +type Page implements Node & ObjectWithMetadata & ObjectWithAttributes @doc(category: "Pages") { """ID of the page.""" id: ID! @@ -8968,17 +8920,13 @@ type Page implements Node & ObjectWithMetadata @doc(category: "Pages") { """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -8987,20 +8935,36 @@ type Page implements Node & ObjectWithMetadata @doc(category: "Pages") { """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ 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 + + """ + 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!]! + """Title of the page for SEO.""" seoTitle: String @@ -9012,17 +8976,13 @@ type Page implements Node & ObjectWithMetadata @doc(category: "Pages") { """ Content of the page. - + Rich text format. For reference see https://editorjs.io/ """ content: JSONString - publicationDate: Date @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `publishedAt` field to fetch the publication date.") + publicationDate: Date @deprecated(reason: "Use the `publishedAt` field to fetch the publication date.") - """ - The page publication date. - - Added in Saleor 3.3. - """ + """The page publication date.""" publishedAt: DateTime """Determines if the page is published.""" @@ -9039,10 +8999,10 @@ type Page implements Node & ObjectWithMetadata @doc(category: "Pages") { """ Content of the page. - + Rich text format. For reference see https://editorjs.io/ """ - contentJson: JSONString! @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `content` field instead.") + contentJson: JSONString! @deprecated(reason: "Use the `content` field instead.") """Returns translated page fields for the given language code.""" translation( @@ -9050,96 +9010,14 @@ type Page implements Node & ObjectWithMetadata @doc(category: "Pages") { languageCode: LanguageCodeEnum! ): PageTranslation - """List of attributes assigned to this product.""" - attributes: [SelectedAttribute!]! -} - -""" -Represents a type of page. It defines what attributes are available to pages of this type. -""" -type PageType implements Node & ObjectWithMetadata @doc(category: "Pages") { - """ID of the page type.""" - id: ID! - - """List of private metadata items. Requires staff permissions to access.""" - privateMetadata: [MetadataItem!]! - - """ - A single key from private metadata. Requires staff permissions to access. - - Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. - """ - privateMetafield(key: String!): String - - """ - Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. - """ - privateMetafields(keys: [String!]): Metadata - - """List of public metadata items. Can be accessed without permissions.""" - metadata: [MetadataItem!]! - - """ - A single key from public metadata. - - Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. - """ - metafield(key: String!): String - - """ - Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. - """ - metafields(keys: [String!]): Metadata - - """Name of the page type.""" - name: String! - - """Slug of the page type.""" - slug: String! - - """Page attributes of that page type.""" - attributes: [Attribute!] - - """ - Attributes that can be assigned to the page type. - - Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES. - """ - availableAttributes( - filter: AttributeFilterInput - where: AttributeWhereInput - - """Return the elements in the list that come before the specified cursor.""" - before: String - - """Return the elements in the list that come after the specified cursor.""" - after: String - - """ - Retrieve the first n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. - """ - first: Int - - """ - Retrieve the last n elements from the list. Note that the system only allows fetching a maximum of 100 objects in a single query. - """ - last: Int - ): AttributeCountableConnection + """Get a single attribute attached to page by attribute slug.""" + attribute( + """Slug of the attribute""" + slug: String! + ): SelectedAttribute @deprecated(reason: "Use `assignedAttribute` field instead.") - """ - Whether page type has pages assigned. - - Requires one of the following permissions: MANAGE_PAGES, MANAGE_PAGE_TYPES_AND_ATTRIBUTES. - """ - hasPages: Boolean + """List of attributes assigned to this page.""" + attributes: [SelectedAttribute!]! @deprecated(reason: "Use `assignedAttributes` field instead.") } """ @@ -9149,11 +9027,7 @@ type VoucherTranslatableContent implements Node @doc(category: "Discounts") { """The ID of the voucher translatable content.""" id: ID! - """ - The ID of the voucher to translate. - - Added in Saleor 3.14. - """ + """The ID of the voucher to translate.""" voucherId: ID! """Voucher name to translate.""" @@ -9167,10 +9041,10 @@ type VoucherTranslatableContent implements Node @doc(category: "Discounts") { """ Vouchers allow giving discounts to particular customers on categories, collections or specific products. They can be used during checkout by providing valid voucher codes. - + Requires one of the following permissions: MANAGE_DISCOUNTS. """ - voucher: Voucher @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.") + voucher: Voucher @deprecated(reason: "Get model fields from the root level queries.") } """Represents voucher translations.""" @@ -9184,11 +9058,7 @@ type VoucherTranslation implements Node @doc(category: "Discounts") { """Translated voucher name.""" name: String - """ - Represents the voucher fields to translate. - - Added in Saleor 3.14. - """ + """Represents the voucher fields to translate.""" translatableContent: VoucherTranslatableContent } @@ -9204,17 +9074,13 @@ type Voucher implements Node & ObjectWithMetadata @doc(category: "Discounts") { """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -9223,17 +9089,13 @@ type Voucher implements Node & ObjectWithMetadata @doc(category: "Discounts") { """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata @@ -9242,7 +9104,7 @@ type Voucher implements Node & ObjectWithMetadata @doc(category: "Discounts") { """ List of codes available for this voucher. - + Added in Saleor 3.18. """ codes( @@ -9263,7 +9125,7 @@ type Voucher implements Node & ObjectWithMetadata @doc(category: "Discounts") { last: Int ): VoucherCodeCountableConnection - """The code of the voucher.This field will be removed in Saleor 4.0.""" + """The code of the voucher.""" code: String """The number of times a voucher can be used.""" @@ -9290,9 +9152,9 @@ type Voucher implements Node & ObjectWithMetadata @doc(category: "Discounts") { """ Determine if the voucher codes can be used once or multiple times. - + Added in Saleor 3.18. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ singleUse: Boolean! @@ -9324,7 +9186,7 @@ type Voucher implements Node & ObjectWithMetadata @doc(category: "Discounts") { """ List of collections this voucher applies to. - + Requires one of the following permissions: MANAGE_DISCOUNTS. """ collections( @@ -9347,7 +9209,7 @@ type Voucher implements Node & ObjectWithMetadata @doc(category: "Discounts") { """ List of products this voucher applies to. - + Requires one of the following permissions: MANAGE_DISCOUNTS. """ products( @@ -9370,9 +9232,7 @@ type Voucher implements Node & ObjectWithMetadata @doc(category: "Discounts") { """ List of product variants this voucher applies to. - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_DISCOUNTS. """ variants( @@ -9419,7 +9279,7 @@ type Voucher implements Node & ObjectWithMetadata @doc(category: "Discounts") { """ List of availability in channels for the voucher. - + Requires one of the following permissions: MANAGE_DISCOUNTS. """ channelListings: [VoucherChannelListing!] @@ -9484,23 +9344,6 @@ type CollectionCountableEdge @doc(category: "Products") { cursor: String! } -type ProductVariantCountableConnection @doc(category: "Products") { - """Pagination data for this connection.""" - pageInfo: PageInfo! - edges: [ProductVariantCountableEdge!]! - - """A total count of items in the collection.""" - totalCount: Int -} - -type ProductVariantCountableEdge @doc(category: "Products") { - """The item at the end of the edge.""" - node: ProductVariant! - - """A cursor for use in pagination.""" - cursor: String! -} - enum DiscountValueTypeEnum @doc(category: "Discounts") { FIXED PERCENTAGE @@ -9537,11 +9380,7 @@ type MenuItemTranslatableContent implements Node @doc(category: "Menu") { """The ID of the menu item translatable content.""" id: ID! - """ - The ID of the menu item to translate. - - Added in Saleor 3.14. - """ + """The ID of the menu item to translate.""" menuItemId: ID! """Name of the menu item to translate.""" @@ -9556,7 +9395,7 @@ type MenuItemTranslatableContent implements Node @doc(category: "Menu") { """ Represents a single item of the related menu. Can store categories, collection or pages. """ - menuItem: MenuItem @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.") + menuItem: MenuItem @deprecated(reason: "Get model fields from the root level queries.") } """Represents menu item translations.""" @@ -9570,11 +9409,7 @@ type MenuItemTranslation implements Node @doc(category: "Menu") { """Translated menu item name.""" name: String! - """ - Represents the menu item fields to translate. - - Added in Saleor 3.14. - """ + """Represents the menu item fields to translate.""" translatableContent: MenuItemTranslatableContent } @@ -9590,17 +9425,13 @@ type MenuItem implements Node & ObjectWithMetadata @doc(category: "Menu") { """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -9609,17 +9440,13 @@ type MenuItem implements Node & ObjectWithMetadata @doc(category: "Menu") { """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata @@ -9673,17 +9500,13 @@ type Menu implements Node & ObjectWithMetadata @doc(category: "Menu") { """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -9692,17 +9515,13 @@ type Menu implements Node & ObjectWithMetadata @doc(category: "Menu") { """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata @@ -9718,8 +9537,6 @@ type Menu implements Node & ObjectWithMetadata @doc(category: "Menu") { """ Represents promotion's original translatable fields and related translations. - -Added in Saleor 3.17. """ type PromotionTranslatableContent implements Node @doc(category: "Discounts") { """ID of the promotion translatable content.""" @@ -9733,7 +9550,7 @@ type PromotionTranslatableContent implements Node @doc(category: "Discounts") { """ Description of the promotion. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString @@ -9745,11 +9562,7 @@ type PromotionTranslatableContent implements Node @doc(category: "Discounts") { ): PromotionTranslation } -""" -Represents promotion translations. - -Added in Saleor 3.17. -""" +"""Represents promotion translations.""" type PromotionTranslation implements Node @doc(category: "Discounts") { """ID of the promotion translation.""" id: ID! @@ -9762,33 +9575,23 @@ type PromotionTranslation implements Node @doc(category: "Discounts") { """ Translated description of the promotion. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString - """ - Represents the promotion fields to translate. - - Added in Saleor 3.14. - """ + """Represents the promotion fields to translate.""" translatableContent: PromotionTranslatableContent } """ Represents promotion rule's original translatable fields and related translations. - -Added in Saleor 3.17. """ type PromotionRuleTranslatableContent implements Node @doc(category: "Discounts") { """ID of the promotion rule translatable content.""" id: ID! - """ - ID of the promotion rule to translate. - - Added in Saleor 3.14. - """ + """ID of the promotion rule to translate.""" promotionRuleId: ID! """Name of the promotion rule.""" @@ -9796,7 +9599,7 @@ type PromotionRuleTranslatableContent implements Node @doc(category: "Discounts" """ Description of the promotion rule. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString @@ -9808,11 +9611,7 @@ type PromotionRuleTranslatableContent implements Node @doc(category: "Discounts" ): PromotionRuleTranslation } -""" -Represents promotion rule translations. - -Added in Saleor 3.17. -""" +"""Represents promotion rule translations.""" type PromotionRuleTranslation implements Node @doc(category: "Discounts") { """ID of the promotion rule translation.""" id: ID! @@ -9825,33 +9624,25 @@ type PromotionRuleTranslation implements Node @doc(category: "Discounts") { """ Translated description of the promotion rule. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString - """ - Represents the promotion rule fields to translate. - - Added in Saleor 3.14. - """ + """Represents the promotion rule fields to translate.""" translatableContent: PromotionRuleTranslatableContent } """ Represents sale's original translatable fields and related translations. -DEPRECATED: this type will be removed in Saleor 4.0. Use `PromotionTranslatableContent` instead. +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! - """ - The ID of the sale to translate. - - Added in Saleor 3.14. - """ + """The ID of the sale to translate.""" saleId: ID! """Name of the sale to translate.""" @@ -9865,16 +9656,16 @@ type SaleTranslatableContent implements Node @doc(category: "Discounts") { """ Sales allow creating discounts for categories, collections or products and are visible to all the customers. - + Requires one of the following permissions: MANAGE_DISCOUNTS. """ - sale: Sale @deprecated(reason: "This field will be removed in Saleor 4.0. Get model fields from the root level queries.") + sale: Sale @deprecated(reason: "Get model fields from the root level queries.") } """ Represents sale translations. -DEPRECATED: this type will be removed in Saleor 4.0. Use `PromotionTranslation` instead. +DEPRECATED: this type will be removed. Use `PromotionTranslation` instead. """ type SaleTranslation implements Node @doc(category: "Discounts") { """The ID of the sale translation.""" @@ -9886,18 +9677,14 @@ type SaleTranslation implements Node @doc(category: "Discounts") { """Translated name of sale.""" name: String - """ - Represents the sale fields to translate. - - Added in Saleor 3.14. - """ + """Represents the sale fields to translate.""" translatableContent: SaleTranslatableContent } """ Sales allow creating discounts for categories, collections or products and are visible to all the customers. -DEPRECATED: this type will be removed in Saleor 4.0. Use `Promotion` type instead. +DEPRECATED: this type will be removed. Use `Promotion` type instead. """ type Sale implements Node & ObjectWithMetadata @doc(category: "Discounts") { """The ID of the sale.""" @@ -9908,17 +9695,13 @@ type Sale implements Node & ObjectWithMetadata @doc(category: "Discounts") { """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -9927,17 +9710,13 @@ type Sale implements Node & ObjectWithMetadata @doc(category: "Discounts") { """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata @@ -9980,7 +9759,7 @@ type Sale implements Node & ObjectWithMetadata @doc(category: "Discounts") { """ List of collections this sale applies to. - + Requires one of the following permissions: MANAGE_DISCOUNTS. """ collections( @@ -10003,7 +9782,7 @@ type Sale implements Node & ObjectWithMetadata @doc(category: "Discounts") { """ List of products this sale applies to. - + Requires one of the following permissions: MANAGE_DISCOUNTS. """ products( @@ -10026,9 +9805,7 @@ type Sale implements Node & ObjectWithMetadata @doc(category: "Discounts") { """ List of product variants this sale applies to. - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_DISCOUNTS. """ variants( @@ -10057,7 +9834,7 @@ type Sale implements Node & ObjectWithMetadata @doc(category: "Discounts") { """ List of channels available for the sale. - + Requires one of the following permissions: MANAGE_DISCOUNTS. """ channelListings: [SaleChannelListing!] @@ -10077,7 +9854,7 @@ enum SaleType @doc(category: "Discounts") { """ Represents sale channel listing. -DEPRECATED: this type will be removed in Saleor 4.0. Use `PromotionRule` type instead. +DEPRECATED: this type will be removed. Use `PromotionRule` type instead. """ type SaleChannelListing implements Node @doc(category: "Discounts") { """The ID of the channel listing.""" @@ -10167,11 +9944,7 @@ input TaxClassFilterInput @doc(category: "Taxes") { countries: [CountryCode!] } -""" -Tax class rates grouped by country. - -Added in Saleor 3.9. -""" +"""Tax class rates grouped by country.""" type TaxCountryConfiguration @doc(category: "Taxes") { """A country for which tax class rates are grouped.""" country: CountryDisplay! @@ -10194,7 +9967,7 @@ type Shop implements ObjectWithMetadata { """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. """ privateMetafield(key: String!): String @@ -10209,7 +9982,7 @@ type Shop implements ObjectWithMetadata { """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. """ metafield(key: String!): String @@ -10224,12 +9997,8 @@ type Shop implements ObjectWithMetadata { """List of available payment gateways.""" availablePaymentGateways( - """ - A currency for which gateways will be returned. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `channel` argument instead. - """ - currency: String + """A currency for which gateways will be returned.""" + currency: String @deprecated(reason: "Use `channel` argument instead.") """Slug of a channel for which the data should be returned.""" channel: String @@ -10249,21 +10018,15 @@ type Shop implements ObjectWithMetadata { """ List of all currencies supported by shop's channels. - - Added in Saleor 3.1. - + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. """ channelCurrencies: [String!]! """List of countries available in the shop.""" countries( - """ - A language code to return the translation for. - - DEPRECATED: this field will be removed in Saleor 4.0. - """ - languageCode: LanguageCodeEnum + """A language code to return the translation for.""" + languageCode: LanguageCodeEnum @deprecated """Filtering options for countries""" filter: CountryFilterInput @@ -10274,14 +10037,14 @@ type Shop implements ObjectWithMetadata { """ Default shop's email sender's name. - + Requires one of the following permissions: MANAGE_SETTINGS. """ defaultMailSenderName: String """ Default shop's email sender's address. - + Requires one of the following permissions: MANAGE_SETTINGS. """ defaultMailSenderAddress: String @@ -10307,18 +10070,10 @@ type Shop implements ObjectWithMetadata { """Header text.""" headerText: String - """ - Automatically approve all new fulfillments. - - Added in Saleor 3.1. - """ + """Automatically approve all new fulfillments.""" fulfillmentAutoApprove: Boolean! - """ - Allow to approve fulfillments which are unpaid. - - Added in Saleor 3.1. - """ + """Allow to approve fulfillments which are unpaid.""" fulfillmentAllowUnpaid: Boolean! """ @@ -10337,48 +10092,42 @@ type Shop implements ObjectWithMetadata { """ Enable automatic fulfillment for all digital products. - + Requires one of the following permissions: MANAGE_SETTINGS. """ automaticFulfillmentDigitalProducts: Boolean """ Default number of minutes stock will be reserved for anonymous checkout or null when stock reservation is disabled. - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_SETTINGS. """ reserveStockDurationAnonymousUser: Int """ Default number of minutes stock will be reserved for authenticated checkout or null when stock reservation is disabled. - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_SETTINGS. """ reserveStockDurationAuthenticatedUser: Int """ Default number of maximum line quantity in single checkout (per single checkout line). - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_SETTINGS. """ limitQuantityPerCheckout: Int """ Default number of max downloads per digital content URL. - + Requires one of the following permissions: MANAGE_SETTINGS. """ defaultDigitalMaxDownloads: Int """ Default number of days which digital content URL will be valid. - + Requires one of the following permissions: MANAGE_SETTINGS. """ defaultDigitalUrlValidDays: Int @@ -10391,67 +10140,66 @@ type Shop implements ObjectWithMetadata { """ List of staff notification recipients. - + Requires one of the following permissions: MANAGE_SETTINGS. """ staffNotificationRecipients: [StaffNotificationRecipient!] """ Determines if account confirmation by email is enabled. - - Added in Saleor 3.14. - + Requires one of the following permissions: MANAGE_SETTINGS. """ enableAccountConfirmationByEmail: Boolean """ Determines if user can login without confirmation when `enableAccountConfirmation` is enabled. - - Added in Saleor 3.15. - + Requires one of the following permissions: MANAGE_SETTINGS. """ allowLoginWithoutConfirmation: Boolean """ Resource limitations and current usage if any set for a shop - + Requires one of the following permissions: AUTHENTICATED_STAFF_USER. """ - limits: LimitInfo! @deprecated(reason: "This field will be removed in Saleor 4.0.") + limits: LimitInfo! @deprecated """ Saleor API version. - + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. """ version: String! - """ - Minor Saleor API version. - - Added in Saleor 3.5. - """ + """Minor Saleor API version.""" schemaVersion: 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!]! """Include taxes in prices.""" - includeTaxesInPrices: Boolean! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `Channel.taxConfiguration.pricesEnteredWithTax` to determine whether prices are entered with tax.") + 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: "This field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to determine whether to display gross or net prices.") + displayGrossPrices: Boolean! @deprecated(reason: "Use `Channel.taxConfiguration` to determine whether to display gross or net prices.") """Charge taxes on shipping.""" - chargeTaxesOnShipping: Boolean! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `ShippingMethodType.taxClass` to determine whether taxes are calculated for shipping methods; if a tax class is set, the taxes will be calculated, otherwise no tax rate will be applied.") + 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.") + + """ + 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 } """ @@ -10550,17 +10298,13 @@ type User implements Node & ObjectWithMetadata @doc(category: "Users") { """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -10569,17 +10313,13 @@ type User implements Node & ObjectWithMetadata @doc(category: "Users") { """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata @@ -10598,24 +10338,20 @@ type User implements Node & ObjectWithMetadata @doc(category: "Users") { """Determine if the user is active.""" isActive: Boolean! - """ - Determines if user has confirmed email. - - Added in Saleor 3.15. - """ + """Determines if user has confirmed email.""" isConfirmed: Boolean! """List of all user's addresses.""" addresses: [Address!]! """Returns the last open checkout of this user.""" - checkout: Checkout @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `checkoutTokens` field to fetch the user checkouts.") + 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: "This field will be removed in Saleor 4.0. Use `checkoutIds` instead.") + ): [UUID!] @deprecated(reason: "Use `checkoutIds` instead.") """Returns the checkout ID's assigned to this user.""" checkoutIds( @@ -10624,9 +10360,7 @@ type User implements Node & ObjectWithMetadata @doc(category: "Users") { ): [ID!] """ - Returns checkouts assigned to this user. - - Added in Saleor 3.8. + 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.""" @@ -10670,13 +10404,13 @@ type User implements Node & ObjectWithMetadata @doc(category: "Users") { """ A note about the customer. - + Requires one of the following permissions: MANAGE_USERS, MANAGE_STAFF. """ note: String """ - List of user's orders. Requires one of the following permissions: MANAGE_STAFF, OWNER. + 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.""" @@ -10707,19 +10441,11 @@ type User implements Node & ObjectWithMetadata @doc(category: "Users") { """ List of channels the user has access to. The sum of channels from all user groups. If at least one group has `restrictedAccessToChannels` set to False - all channels are returned. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ accessibleChannels: [Channel!] """ Determine if user have restricted access to channels. False if at least one user group has `restrictedAccessToChannels` set to False. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ restrictedAccessToChannels: Boolean! @@ -10732,15 +10458,13 @@ type User implements Node & ObjectWithMetadata @doc(category: "Users") { """ The format of the image. When not provided, format of the original image will be used. - - Added in Saleor 3.6. """ format: ThumbnailFormatEnum = ORIGINAL ): Image """ List of events associated with the user. - + Requires one of the following permissions: MANAGE_USERS, MANAGE_STAFF. """ events: [CustomerEvent!] @@ -10762,11 +10486,7 @@ type User implements Node & ObjectWithMetadata @doc(category: "Users") { """The default billing address of the user.""" defaultBillingAddress: Address - """ - External ID of this user. - - Added in Saleor 3.10. - """ + """External ID of this user.""" externalReference: String """The date when the user last time log in to the system.""" @@ -10780,10 +10500,6 @@ type User implements Node & ObjectWithMetadata @doc(category: "Users") { """ 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. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ storedPaymentMethods( """Slug of a channel for which the data should be returned.""" @@ -10801,17 +10517,13 @@ type Checkout implements Node & ObjectWithMetadata @doc(category: "Checkout") { """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -10820,30 +10532,22 @@ type Checkout implements Node & ObjectWithMetadata @doc(category: "Checkout") { """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata """The date and time when the checkout was created.""" created: DateTime! - """ - Time of last modification of the given checkout. - - Added in Saleor 3.13. - """ + """Time of last modification of the given checkout.""" updatedAt: DateTime! - lastChange: DateTime! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `updatedAt` instead.") + lastChange: DateTime! @deprecated(reason: "Use `updatedAt` instead.") """ The user assigned to the checkout. Requires one of the following permissions: MANAGE_USERS, HANDLE_PAYMENTS, OWNER. @@ -10859,8 +10563,15 @@ type Checkout implements Node & ObjectWithMetadata @doc(category: "Checkout") { """The shipping address of the checkout.""" shippingAddress: Address + """ + The customer note for the checkout. + + Added in Saleor 3.21. + """ + customerNote: String! + """The note for the checkout.""" - note: String! + note: String! @deprecated(reason: "Use `customerNote` instead.") """ The total discount applied to the checkout. Note: Only discount created via voucher are included in this field. @@ -10877,9 +10588,9 @@ type Checkout implements Node & ObjectWithMetadata @doc(category: "Checkout") { """ The voucher assigned to the checkout. - + Added in Saleor 3.18. - + Requires one of the following permissions: MANAGE_DISCOUNTS. """ voucher: Voucher @@ -10889,32 +10600,28 @@ type Checkout implements Node & ObjectWithMetadata @doc(category: "Checkout") { """ 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!]! @webhookEventsInfo(asyncEvents: [], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT, CHECKOUT_FILTER_SHIPPING_METHODS]) @deprecated(reason: "This field will be removed in Saleor 4.0. Use `shippingMethods` instead.") + availableShippingMethods: [ShippingMethod!]! @webhookEventsInfo(asyncEvents: [], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT, CHECKOUT_FILTER_SHIPPING_METHODS]) @deprecated(reason: "Use `shippingMethods` instead.") """ 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. """ shippingMethods: [ShippingMethod!]! @webhookEventsInfo(asyncEvents: [], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT, CHECKOUT_FILTER_SHIPPING_METHODS]) - """ - Collection points that can be used for this order. - - Added in Saleor 3.1. - """ + """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. """ @@ -10934,8 +10641,6 @@ type Checkout implements Node & ObjectWithMetadata @doc(category: "Checkout") { """ Date when oldest stock reservation for this checkout expires or null if no stock is reserved. - - Added in Saleor 3.1. """ stockReservationExpires: DateTime @@ -10946,7 +10651,7 @@ type Checkout implements Node & ObjectWithMetadata @doc(category: "Checkout") { """ 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. """ @@ -10954,18 +10659,16 @@ type Checkout implements Node & ObjectWithMetadata @doc(category: "Checkout") { """ 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: "This field will be removed in Saleor 4.0. Use `deliveryMethod` instead.") + shippingMethod: ShippingMethod @webhookEventsInfo(asyncEvents: [], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT, CHECKOUT_FILTER_SHIPPING_METHODS]) @deprecated(reason: "Use `deliveryMethod` instead.") """ The delivery method selected for this checkout. - - Added in Saleor 3.1. - + 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. @@ -10974,17 +10677,13 @@ type Checkout implements Node & ObjectWithMetadata @doc(category: "Checkout") { """ 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]) - """ - Returns True if checkout has to be exempt from taxes. - - Added in Saleor 3.8. - """ + """Returns True if checkout has to be exempt from taxes.""" taxExemption: Boolean! """The checkout's token.""" @@ -10992,7 +10691,7 @@ type Checkout implements Node & ObjectWithMetadata @doc(category: "Checkout") { """ 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. """ @@ -11000,11 +10699,7 @@ type Checkout implements Node & ObjectWithMetadata @doc(category: "Checkout") { """ The difference between the paid and the checkout total amount. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Triggers the following webhook events: - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired. """ @@ -11015,27 +10710,15 @@ type Checkout implements Node & ObjectWithMetadata @doc(category: "Checkout") { """ List of transactions for the checkout. Requires one of the following permissions: MANAGE_CHECKOUTS, HANDLE_PAYMENTS. - - Added in Saleor 3.4. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ transactions: [TransactionItem!] - """ - Determines whether displayed prices should include taxes. - - Added in Saleor 3.9. - """ + """Determines whether displayed prices should include taxes.""" displayGrossPrices: Boolean! """ The authorize status of the checkout. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Triggers the following webhook events: - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired. """ @@ -11043,11 +10726,7 @@ type Checkout implements Node & ObjectWithMetadata @doc(category: "Checkout") { """ The charge status of the checkout. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Triggers the following webhook events: - CHECKOUT_CALCULATE_TAXES (sync): Optionally triggered when checkout prices are expired. """ @@ -11055,23 +10734,13 @@ type Checkout implements Node & ObjectWithMetadata @doc(category: "Checkout") { """ 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. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ storedPaymentMethods( """Amount that will be used to fetch stored payment methods.""" amount: PositiveDecimal ): [StoredPaymentMethod!] - """ - List of problems with the checkout. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """List of problems with the checkout.""" problems: [CheckoutProblem!] } @@ -11087,17 +10756,13 @@ type GiftCard implements Node & ObjectWithMetadata @doc(category: "Gift cards") """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -11106,17 +10771,13 @@ type GiftCard implements Node & ObjectWithMetadata @doc(category: "Gift cards") """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata @@ -11128,7 +10789,7 @@ type GiftCard implements Node & ObjectWithMetadata @doc(category: "Gift cards") """ 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! @@ -11136,35 +10797,21 @@ type GiftCard implements Node & ObjectWithMetadata @doc(category: "Gift cards") """Date and time when gift card was created.""" created: DateTime! - """ - The user who bought or issued a gift card. - - Added in Saleor 3.1. - """ + """The user who bought or issued a gift card.""" createdBy: User - """ - The customer who used a gift card. - - Added in Saleor 3.1. - """ - usedBy: User @deprecated(reason: "This field will be removed in Saleor 4.0.") + """The customer who used a gift card.""" + usedBy: User @deprecated """ Email address of the user who bought or issued gift card. - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_USERS, OWNER. """ createdByEmail: String - """ - Email address of the customer who used a gift card. - - Added in Saleor 3.1. - """ - usedByEmail: String @deprecated(reason: "This field will be removed in Saleor 4.0.") + """Email address of the customer who used a gift card.""" + usedByEmail: String @deprecated """Date and time when gift card was last used.""" lastUsedOn: DateTime @@ -11174,25 +10821,17 @@ type GiftCard implements Node & ObjectWithMetadata @doc(category: "Gift cards") """ App which created the gift card. - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_APPS, OWNER. """ app: App - """ - Related gift card product. - - Added in Saleor 3.1. - """ + """Related gift card product.""" product: Product """ List of events associated with the gift card. - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_GIFT_CARD. """ events( @@ -11202,38 +10841,28 @@ type GiftCard implements Node & ObjectWithMetadata @doc(category: "Gift cards") """ The gift card tag. - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_GIFT_CARD. """ tags: [GiftCardTag!]! - """ - Slug of the channel where the gift card was bought. - - Added in Saleor 3.1. - """ + """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: "This field will be removed in Saleor 4.0. Use `createdBy` field instead.") + user: User @deprecated(reason: "Use `createdBy` field instead.") """End date of gift card.""" - endDate: DateTime @deprecated(reason: "This field will be removed in Saleor 4.0. Use `expiryDate` field instead.") + endDate: DateTime @deprecated(reason: "Use `expiryDate` field instead.") """Start date of gift card.""" - startDate: DateTime @deprecated(reason: "This field will be removed in Saleor 4.0.") + startDate: DateTime @deprecated } -""" -History log of the gift card. - -Added in Saleor 3.1. -""" +"""History log of the gift card.""" type GiftCardEvent implements Node @doc(category: "Gift cards") { """ID of the event associated with a gift card.""" id: ID! @@ -11282,7 +10911,6 @@ type GiftCardEvent implements Node @doc(category: "Gift cards") { oldExpiryDate: Date } -"""An enumeration.""" enum GiftCardEventsEnum @doc(category: "Gift cards") { ISSUED BOUGHT @@ -11317,11 +10945,7 @@ input GiftCardEventFilterInput @doc(category: "Gift cards") { orders: [ID!] } -""" -The gift card tag. - -Added in Saleor 3.1. -""" +"""The gift card tag.""" type GiftCardTag implements Node @doc(category: "Gift cards") { """ID of the tag associated with a gift card.""" id: ID! @@ -11335,49 +10959,33 @@ type CheckoutLine implements Node & ObjectWithMetadata @doc(category: "Checkout" """The ID of the checkout line.""" id: ID! - """ - List of private metadata items. Requires staff permissions to access. - - Added in Saleor 3.5. - """ + """List of private metadata items. Requires staff permissions to access.""" privateMetadata: [MetadataItem!]! """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.5. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.5. """ privateMetafields(keys: [String!]): Metadata - """ - List of public metadata items. Can be accessed without permissions. - - Added in Saleor 3.5. - """ + """List of public metadata items. Can be accessed without permissions.""" metadata: [MetadataItem!]! """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.5. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.5. """ metafields(keys: [String!]): Metadata @@ -11389,7 +10997,7 @@ type CheckoutLine implements Node & ObjectWithMetadata @doc(category: "Checkout" """ 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. """ @@ -11398,9 +11006,16 @@ type CheckoutLine implements Node & ObjectWithMetadata @doc(category: "Checkout" """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. """ @@ -11409,43 +11024,34 @@ type CheckoutLine implements Node & ObjectWithMetadata @doc(category: "Checkout" """The sum of the checkout line price, without discounts.""" undiscountedTotalPrice: Money! + """ + The sum of the checkout line price prior to promotion. + + Added in Saleor 3.21. + """ + priorTotalPrice: Money + """Indicates whether the item need to be delivered.""" requiresShipping: Boolean! - """ - List of problems with the checkout line. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """List of problems with the checkout line.""" problems: [CheckoutLineProblem!] """ Determine if the line is a gift. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ isGift: Boolean } -""" -Represents an problem in the checkout line. - -Added in Saleor 3.15. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Represents an problem in the checkout line.""" union CheckoutLineProblem = CheckoutLineProblemInsufficientStock | CheckoutLineProblemVariantNotAvailable """ Indicates insufficient stock for a given checkout line.Placing the order will not be possible until solving this problem. - -Added in Saleor 3.15. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. """ type CheckoutLineProblemInsufficientStock @doc(category: "Checkout") { """Available quantity of a variant.""" @@ -11460,10 +11066,6 @@ type CheckoutLineProblemInsufficientStock @doc(category: "Checkout") { """ The variant assigned to the checkout line is not available.Placing the order will not be possible until solving this problem. - -Added in Saleor 3.15. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. """ type CheckoutLineProblemVariantNotAvailable @doc(category: "Checkout") { """The line that has variant that is not available.""" @@ -11472,18 +11074,10 @@ type CheckoutLineProblemVariantNotAvailable @doc(category: "Checkout") { """ Represents a delivery method chosen for the checkout. `Warehouse` type is used when checkout is marked as "click and collect" and `ShippingMethod` otherwise. - -Added in Saleor 3.1. """ union DeliveryMethod = Warehouse | ShippingMethod -""" -Represents a payment transaction. - -Added in Saleor 3.4. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Represents a payment transaction.""" type TransactionItem implements Node & ObjectWithMetadata @doc(category: "Payments") { """The ID of the object.""" id: ID! @@ -11493,17 +11087,13 @@ type TransactionItem implements Node & ObjectWithMetadata @doc(category: "Paymen """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -11512,25 +11102,17 @@ type TransactionItem implements Node & ObjectWithMetadata @doc(category: "Paymen """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata - """ - The transaction token. - - Added in Saleor 3.14. - """ + """The transaction token.""" token: UUID! """Date and time at which payment transaction was created.""" @@ -11547,98 +11129,73 @@ type TransactionItem implements Node & ObjectWithMetadata @doc(category: "Paymen """Total amount authorized for this payment.""" authorizedAmount: Money! - """ - Total amount of ongoing authorization requests for the transaction. - - Added in Saleor 3.13. - """ + """Total amount of ongoing authorization requests for the transaction.""" authorizePendingAmount: Money! """Total amount refunded for this payment.""" refundedAmount: Money! - """ - Total amount of ongoing refund requests for the transaction. - - Added in Saleor 3.13. - """ + """Total amount of ongoing refund requests for the transaction.""" refundPendingAmount: Money! - """ - Total amount canceled for this payment. - - Added in Saleor 3.13. - """ + """Total amount canceled for this payment.""" canceledAmount: Money! - """ - Total amount of ongoing cancel requests for the transaction. - - Added in Saleor 3.13. - """ + """Total amount of ongoing cancel requests for the transaction.""" cancelPendingAmount: Money! """Total amount charged for this payment.""" chargedAmount: Money! - """ - Total amount of ongoing charge requests for the transaction. - - Added in Saleor 3.13. - """ + """Total amount of ongoing charge requests for the transaction.""" chargePendingAmount: Money! - """ - Name of the transaction. - - Added in Saleor 3.13. - """ + """Name of the transaction.""" name: String! - """ - Message related to the transaction. - - Added in Saleor 3.13. - """ + """Message related to the transaction.""" message: String! - """ - PSP reference of transaction. - - Added in Saleor 3.13. - """ + """PSP reference of transaction.""" pspReference: String! - """ - The related order. - - Added in Saleor 3.6. - """ + """The related order.""" order: Order - """ - The related checkout. - - Added in Saleor 3.14. - """ + """The related checkout.""" checkout: Checkout """List of all transaction's events.""" events: [TransactionEvent!]! - """ - User or App that created the transaction. - - Added in Saleor 3.13. - """ + """User or App that created the transaction.""" createdBy: UserOrApp """ The url that will allow to redirect user to payment provider page with transaction details. - - Added in Saleor 3.13. """ externalUrl: String! + + """ + The payment method used for this transaction. + + Added in Saleor 3.22. + """ + paymentMethodDetails: PaymentMethodDetails + + """ + Reason of the refund. + + Added in Saleor 3.22. + """ + reason: String + + """ + Reason `Page` (Model) for refund. + + Added in Saleor 3.22. + """ + reasonReference: Page } """ @@ -11665,17 +11222,13 @@ type Order implements Node & ObjectWithMetadata @doc(category: "Orders") { """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -11684,17 +11237,13 @@ type Order implements Node & ObjectWithMetadata @doc(category: "Orders") { """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata @@ -11712,9 +11261,7 @@ type Order implements Node & ObjectWithMetadata @doc(category: "Orders") { """ user: User - """ - Google Analytics tracking client ID. This field will be removed in Saleor 4.0. - """ + """Google Analytics tracking client ID.""" trackingClientId: String! """ @@ -11755,11 +11302,7 @@ type Order implements Node & ObjectWithMetadata @doc(category: "Orders") { """Shipping methods related to this order.""" shippingMethods: [ShippingMethod!]! - """ - Collection points that can be used for this order. - - Added in Saleor 3.1. - """ + """Collection points that can be used for this order.""" availableCollectionPoints: [Warehouse!]! """ @@ -11785,31 +11328,17 @@ type Order implements Node & ObjectWithMetadata @doc(category: "Orders") { """User-friendly payment status.""" paymentStatusDisplay: String! - """ - The authorize status of the order. - - Added in Saleor 3.4. - """ + """The authorize status of the order.""" authorizeStatus: OrderAuthorizeStatusEnum! - """ - The charge status of the order. - - Added in Saleor 3.4. - """ + """The charge status of the order.""" chargeStatus: OrderChargeStatusEnum! - """ - Returns True if order has to be exempt from taxes. - - Added in Saleor 3.8. - """ + """Returns True if order has to be exempt from taxes.""" taxExemption: Boolean! """ List of transactions for the order. Requires one of the following permissions: MANAGE_ORDERS, HANDLE_PAYMENTS. - - Added in Saleor 3.4. """ transactions: [TransactionItem!]! @@ -11823,14 +11352,14 @@ type Order implements Node & ObjectWithMetadata @doc(category: "Orders") { undiscountedTotal: TaxedMoney! """Shipping method for this order.""" - shippingMethod: ShippingMethod @deprecated(reason: "This field will be removed in Saleor 4.0. Use `deliveryMethod` instead.") + shippingMethod: ShippingMethod @deprecated(reason: "Use `deliveryMethod` instead.") """ Undiscounted total price of shipping. - + Added in Saleor 3.19. """ - undiscountedShippingPrice: Money + undiscountedShippingPrice: Money! """Total price of shipping.""" shippingPrice: TaxedMoney! @@ -11840,41 +11369,29 @@ type Order implements Node & ObjectWithMetadata @doc(category: "Orders") { """ Denormalized tax class assigned to the shipping method. - - Added in Saleor 3.9. - + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. """ shippingTaxClass: TaxClass - """ - Denormalized name of the tax class assigned to the shipping method. - - Added in Saleor 3.9. - """ + """Denormalized name of the tax class assigned to the shipping method.""" shippingTaxClassName: String - """ - Denormalized public metadata of the shipping method's tax class. - - Added in Saleor 3.9. - """ + """Denormalized public metadata of the shipping method's tax class.""" shippingTaxClassMetadata: [MetadataItem!]! """ Denormalized private metadata of the shipping method's tax class. Requires staff permissions to access. - - Added in Saleor 3.9. """ shippingTaxClassPrivateMetadata: [MetadataItem!]! - token: String! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `id` instead.") + token: String! @deprecated(reason: "Use `id` instead.") """Voucher linked to the order.""" voucher: Voucher """ Voucher code that was used for Order. - + Added in Saleor 3.18. """ voucherCode: String @@ -11906,25 +11423,17 @@ type Order implements Node & ObjectWithMetadata @doc(category: "Orders") { totalAuthorized: Money! """Amount captured for the order.""" - totalCaptured: Money! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `totalCharged` instead.") + totalCaptured: Money! @deprecated(reason: "Use `totalCharged` instead.") - """ - Amount charged for the order. - - Added in Saleor 3.13. - """ + """Amount charged for the order.""" totalCharged: Money! - """ - Amount canceled for the order. - - Added in Saleor 3.13. - """ + """Amount canceled for the order.""" totalCanceled: Money! """ List of events associated with the order. - + Requires one of the following permissions: MANAGE_ORDERS. """ events: [OrderEvent!]! @@ -11940,25 +11449,21 @@ type Order implements Node & ObjectWithMetadata @doc(category: "Orders") { """Returns True, if order requires shipping.""" isShippingRequired: Boolean! - """ - The delivery method selected for this order. - - Added in Saleor 3.1. - """ + """The delivery method selected for this order.""" deliveryMethod: DeliveryMethod - languageCode: String! @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `languageCodeEnum` field to fetch the language code. ") + 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: "This field will be removed in Saleor 4.0. Use the `discounts` field instead.") + discount: Money @deprecated(reason: "Use the `discounts` field instead.") """Discount name.""" - discountName: String @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `discounts` field instead.") + discountName: String @deprecated(reason: "Use the `discounts` field instead.") """Translated discount name.""" - translatedDiscountName: String @deprecated(reason: "This field will be removed in Saleor 4.0. Use the `discounts` field instead. ") + translatedDiscountName: String @deprecated(reason: "Use the `discounts` field instead.") """List of all discounts assigned to the order.""" discounts: [OrderDiscount!]! @@ -11966,115 +11471,68 @@ type Order implements Node & ObjectWithMetadata @doc(category: "Orders") { """List of errors that occurred during order validation.""" errors: [OrderError!]! - """ - Determines whether displayed prices should include taxes. - - Added in Saleor 3.9. - """ + """Determines whether displayed prices should include taxes.""" displayGrossPrices: Boolean! - """ - External ID of this order. - - Added in Saleor 3.10. - """ + """External ID of this order.""" externalReference: String - """ - ID of the checkout that the order was created from. - - Added in Saleor 3.11. - """ + """ID of the checkout that the order was created from.""" checkoutId: ID """ List of granted refunds. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_ORDERS. """ grantedRefunds: [OrderGrantedRefund!]! """ Total amount of granted refund. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_ORDERS. """ totalGrantedRefund: Money! - """ - Total refund amount for the order. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Total refund amount for the order.""" totalRefunded: Money! """ Total amount of ongoing refund requests for the order's transactions. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_ORDERS. """ totalRefundPending: Money! """ Total amount of ongoing authorize requests for the order's transactions. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_ORDERS. """ totalAuthorizePending: Money! """ Total amount of ongoing charge requests for the order's transactions. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_ORDERS. """ totalChargePending: Money! """ Total amount of ongoing cancel requests for the order's transactions. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_ORDERS. """ totalCancelPending: Money! """ The difference amount between granted refund and the amounts that are pending and refunded. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_ORDERS. """ totalRemainingGrant: Money! } -"""An enumeration.""" enum OrderStatus @doc(category: "Orders") { DRAFT UNCONFIRMED @@ -12097,17 +11555,13 @@ type Fulfillment implements Node & ObjectWithMetadata @doc(category: "Orders") { """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -12116,17 +11570,13 @@ type Fulfillment implements Node & ObjectWithMetadata @doc(category: "Orders") { """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata @@ -12151,22 +11601,13 @@ type Fulfillment implements Node & ObjectWithMetadata @doc(category: "Orders") { """Warehouse from fulfillment was fulfilled.""" warehouse: Warehouse - """ - Amount of refunded shipping price. - - Added in Saleor 3.14. - """ + """Amount of refunded shipping price.""" shippingRefundedAmount: Money - """ - Total refunded amount assigned to this fulfillment. - - Added in Saleor 3.14. - """ + """Total refunded amount assigned to this fulfillment.""" totalRefundedAmount: Money } -"""An enumeration.""" enum FulfillmentStatus @doc(category: "Orders") { FULFILLED REFUNDED @@ -12194,49 +11635,33 @@ type OrderLine implements Node & ObjectWithMetadata @doc(category: "Orders") { """ID of the order line.""" id: ID! - """ - List of private metadata items. Requires staff permissions to access. - - Added in Saleor 3.5. - """ + """List of private metadata items. Requires staff permissions to access.""" privateMetadata: [MetadataItem!]! """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.5. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.5. """ privateMetafields(keys: [String!]): Metadata - """ - List of public metadata items. Can be accessed without permissions. - - Added in Saleor 3.5. - """ + """List of public metadata items. Can be accessed without permissions.""" metadata: [MetadataItem!]! """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.5. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.5. """ metafields(keys: [String!]): Metadata @@ -12261,9 +11686,6 @@ type OrderLine implements Node & ObjectWithMetadata @doc(category: "Orders") { """Number of variant items fulfilled.""" quantityFulfilled: Int! - """Reason for any discounts applied on a product in the order.""" - unitDiscountReason: String - """Rate of tax applied on product variant.""" taxRate: Float! digitalContentUrl: DigitalContentUrl @@ -12275,37 +11697,47 @@ type OrderLine implements Node & ObjectWithMetadata @doc(category: "Orders") { """ The format of the image. When not provided, format of the original image will be used. - - Added in Saleor 3.6. """ format: ThumbnailFormatEnum = ORIGINAL ): Image - """Price of the single item in the order line.""" + """ + 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 applied an order line discount. + Price of the single item in the order line without any discount applied. """ undiscountedUnitPrice: TaxedMoney! - """The discount applied to the single order line.""" + """ + 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! - """Value of the discount. Can store fixed value or percent value""" + """ + 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. - - Added in Saleor 3.14. - """ + """Returns True, if the line unit price was overridden.""" isPriceOverridden: Boolean """ @@ -12321,73 +11753,55 @@ type OrderLine implements Node & ObjectWithMetadata @doc(category: "Orders") { """ List of allocations across warehouses. - + Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS. """ allocations: [Allocation!] """ Denormalized sale ID, set when order line is created for a product variant that is on sale. - - Added in Saleor 3.14. """ saleId: ID - """ - A quantity of items remaining to be fulfilled. - - Added in Saleor 3.1. - """ + """A quantity of items remaining to be fulfilled.""" quantityToFulfill: Int! - """Type of the discount: fixed or percent""" - unitDiscountType: DiscountValueTypeEnum - """ Denormalized tax class of the product in this order line. - - Added in Saleor 3.9. - + Requires one of the following permissions: AUTHENTICATED_STAFF_USER, AUTHENTICATED_APP. """ taxClass: TaxClass - """ - Denormalized name of the tax class. - - Added in Saleor 3.9. - """ + """Denormalized name of the tax class.""" taxClassName: String - """ - Denormalized public metadata of the tax class. - - Added in Saleor 3.9. - """ + """Denormalized public metadata of the tax class.""" taxClassMetadata: [MetadataItem!]! """ Denormalized private metadata of the tax class. Requires staff permissions to access. - - Added in Saleor 3.9. """ taxClassPrivateMetadata: [MetadataItem!]! - """ - Voucher code that was used for this order line. - - Added in Saleor 3.14. - """ + """Voucher code that was used for this order line.""" voucherCode: String """ Determine if the line is a gift. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ isGift: Boolean + + """ + List of applied discounts + + Added in Saleor 3.21. + """ + discounts: [OrderLineDiscount!] } """ @@ -12404,70 +11818,104 @@ type Allocation implements Node @doc(category: "Products") { """ Quantity allocated for orders. - + Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS. """ quantity: Int! """ The warehouse were items were allocated. - + Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS. """ warehouse: Warehouse! } -enum OrderAction @doc(category: "Payments") { - """Represents the capture action.""" - CAPTURE +"""Represent the discount applied to order line.""" +type OrderLineDiscount @doc(category: "Orders") { + """The ID of discount applied.""" + id: ID! - """Represents a mark-as-paid action.""" - MARK_AS_PAID + """The type of applied discount: Sale, Voucher or Manual.""" + type: OrderDiscountType! - """Represents a refund action.""" - REFUND + """The name of applied discount.""" + name: String - """Represents a void action.""" - VOID -} + """Translated name of the applied discount.""" + translatedName: String -"""Represents an Invoice.""" -type Invoice implements ObjectWithMetadata & Job & Node @doc(category: "Orders") { - """List of private metadata items. Requires staff permissions to access.""" - privateMetadata: [MetadataItem!]! + """Type of the discount: fixed or percent""" + valueType: DiscountValueTypeEnum! - """ - A single key from private metadata. Requires staff permissions to access. - - Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. - """ - privateMetafield(key: String!): String + """Value of the discount. Can store fixed value or percent value""" + value: PositiveDecimal! """ - Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. - """ - privateMetafields(keys: [String!]): Metadata + Explanation for the applied discount. + + Requires one of the following permissions: MANAGE_ORDERS. + """ + reason: String + + """The discount amount applied to the line item.""" + total: Money! + + """The discount amount applied to the single line unit.""" + unit: Money! +} + +enum OrderDiscountType @doc(category: "Discounts") { + SALE + VOUCHER + MANUAL + PROMOTION + ORDER_PROMOTION +} + +enum OrderAction @doc(category: "Payments") { + """Represents the capture action.""" + CAPTURE + + """Represents a mark-as-paid action.""" + MARK_AS_PAID + + """Represents a refund action.""" + REFUND + + """Represents a void action.""" + VOID +} + +"""Represents an Invoice.""" +type Invoice implements ObjectWithMetadata & Job & Node @doc(category: "Orders") { + """List of private metadata items. Requires staff permissions to access.""" + privateMetadata: [MetadataItem!]! + + """ + A single key from private metadata. Requires staff permissions to access. + + Tip: Use GraphQL aliases to fetch multiple keys. + """ + 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. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata @@ -12490,18 +11938,12 @@ type Invoice implements ObjectWithMetadata & Job & Node @doc(category: "Orders") number: String """URL to view an invoice.""" - externalUrl: String @deprecated(reason: "This field will be removed in Saleor 4.0. Use `url` field.This field will be removed in 4.0") + externalUrl: String @deprecated(reason: "Use `url` field.") - """ - URL to view/download an invoice. This can be an internal URL if the Invoicing Plugin was used or an external URL if it has been provided. - """ + """URL to view/download an invoice.""" url: String - """ - Order related to the invoice. - - Added in Saleor 3.10. - """ + """Order related to the invoice.""" order: Order } @@ -12519,7 +11961,6 @@ interface Job { message: String } -"""An enumeration.""" enum JobStatusEnum { PENDING SUCCESS @@ -12527,7 +11968,6 @@ enum JobStatusEnum { DELETED } -"""An enumeration.""" enum OrderOriginEnum @doc(category: "Orders") { CHECKOUT DRAFT @@ -12535,7 +11975,6 @@ enum OrderOriginEnum @doc(category: "Orders") { BULK_CREATE } -"""An enumeration.""" enum PaymentChargeStatusEnum @doc(category: "Payments") { NOT_CHARGED PENDING @@ -12606,17 +12045,13 @@ type Payment implements Node & ObjectWithMetadata @doc(category: "Payments") { """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -12625,17 +12060,13 @@ type Payment implements Node & ObjectWithMetadata @doc(category: "Payments") { """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata @@ -12665,7 +12096,7 @@ type Payment implements Node & ObjectWithMetadata @doc(category: "Payments") { """ IP address of the user who created the payment. - + Requires one of the following permissions: MANAGE_ORDERS. """ customerIpAddress: String @@ -12675,7 +12106,7 @@ type Payment implements Node & ObjectWithMetadata @doc(category: "Payments") { """ List of actions that can be performed in the current state of a payment. - + Requires one of the following permissions: MANAGE_ORDERS. """ actions: [OrderAction!]! @@ -12688,21 +12119,21 @@ type Payment implements Node & ObjectWithMetadata @doc(category: "Payments") { """ List of all transactions within this payment. - + Requires one of the following permissions: MANAGE_ORDERS. """ transactions: [Transaction!] """ Maximum amount of money that can be captured. - + Requires one of the following permissions: MANAGE_ORDERS. """ availableCaptureAmount: Money """ Maximum amount of money that can be refunded. - + Requires one of the following permissions: MANAGE_ORDERS. """ availableRefundAmount: Money @@ -12710,18 +12141,10 @@ type Payment implements Node & ObjectWithMetadata @doc(category: "Payments") { """The details of the card used for this payment.""" creditCard: CreditCard - """ - Informs whether this is a partial payment. - - Added in Saleor 3.14. - """ + """Informs whether this is a partial payment.""" partial: Boolean! - """ - PSP reference of the payment. - - Added in Saleor 3.14. - """ + """PSP reference of the payment.""" pspReference: String } @@ -12749,13 +12172,12 @@ type Transaction implements Node @doc(category: "Payments") { error: String """Response returned by payment gateway.""" - gatewayResponse: JSONString! + gatewayResponse: JSONString! @deprecated(reason: "This field is a part of a legacy Payments API. Please use apps instead.") """Total amount of the transaction.""" amount: Money } -"""An enumeration.""" enum TransactionKind @doc(category: "Payments") { EXTERNAL AUTH @@ -12856,13 +12278,7 @@ type OrderEvent implements Node @doc(category: "Orders") { """The order which is related to this order.""" relatedOrder: Order - """ - The order event which is related to this event. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """The order event which is related to this event.""" related: OrderEvent """The discount applied to the order.""" @@ -12880,6 +12296,7 @@ enum OrderEventsEnum @doc(category: "Orders") { REMOVED_PRODUCTS PLACED PLACED_FROM_DRAFT + PLACED_AUTOMATICALLY_FROM_PAID_CHECKOUT OVERSOLD_ITEMS CANCELED EXPIRED @@ -12925,7 +12342,6 @@ enum OrderEventsEnum @doc(category: "Orders") { OTHER } -"""An enumeration.""" enum OrderEventsEmailsEnum @doc(category: "Orders") { PAYMENT_CONFIRMATION CONFIRMED @@ -12997,22 +12413,20 @@ type OrderDiscount implements Node @doc(category: "Discounts") { """ Explanation for the applied discount. - + Requires one of the following permissions: MANAGE_ORDERS. """ reason: String """Returns amount of discount.""" - amount: Money! -} + amount: Money! @deprecated(reason: "Use `total` instead.") -"""An enumeration.""" -enum OrderDiscountType @doc(category: "Discounts") { - SALE - VOUCHER - MANUAL - PROMOTION - ORDER_PROMOTION + """ + The amount of discount applied to the order. + + Added in Saleor 3.21. + """ + total: Money! } type OrderError @doc(category: "Orders") { @@ -13040,7 +12454,6 @@ type OrderError @doc(category: "Orders") { addressType: AddressTypeEnum } -"""An enumeration.""" enum OrderErrorCode @doc(category: "Orders") { BILLING_ADDRESS_NOT_SET CANNOT_CANCEL_FULFILLMENT @@ -13078,21 +12491,15 @@ enum OrderErrorCode @doc(category: "Orders") { INVALID_VOUCHER_CODE NON_EDITABLE_GIFT_LINE NON_REMOVABLE_GIFT_LINE + MISSING_ADDRESS_DATA } -"""An enumeration.""" enum AddressTypeEnum { BILLING SHIPPING } -""" -The details of granted refund. - -Added in Saleor 3.13. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""The details of granted refund.""" type OrderGrantedRefund @doc(category: "Orders") { id: ID! @@ -13105,9 +12512,20 @@ type OrderGrantedRefund @doc(category: "Orders") { """Refund amount.""" amount: Money! - """Reason of the refund.""" + """ + Reason of the refund. + + Added in Saleor 3.22. + """ reason: String + """ + Reason Model (Page) reference for refund. + + Added in Saleor 3.22. + """ + reasonReference: Page + """ User who performed the action. Requires of of the following permissions: MANAGE_USERS, MANAGE_STAFF, OWNER. """ @@ -13118,51 +12536,35 @@ type OrderGrantedRefund @doc(category: "Orders") { """ If true, the refunded amount includes the shipping price.If false, the refunded amount does not include the shipping price. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ shippingCostsIncluded: Boolean! - """ - Lines assigned to the granted refund. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Lines assigned to the granted refund.""" lines: [OrderGrantedRefundLine!] """ Status of the granted refund calculated based on transactionItem assigned to granted refund. - + Added in Saleor 3.20. """ status: OrderGrantedRefundStatusEnum! """ List of refund events associated with the granted refund. - + Added in Saleor 3.20. """ transactionEvents: [TransactionEvent!] """ The transaction assigned to the granted refund. - + Added in Saleor 3.20. """ transaction: TransactionItem } -""" -Represents granted refund line. - -Added in Saleor 3.15. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Represents granted refund line.""" type OrderGrantedRefundLine { id: ID! @@ -13199,53 +12601,34 @@ type TransactionEvent implements Node @doc(category: "Payments") { """Date and time at which a transaction event was created.""" createdAt: DateTime! - """ - PSP reference of transaction. - - Added in Saleor 3.13. - """ + """PSP reference of transaction.""" pspReference: String! + """Message related to the transaction's event.""" + message: String! + """ - Message related to the transaction's event. - - Added in Saleor 3.13. + Reason model of the transaction refund. + + Added in Saleor 3.22. """ - message: String! + reasonReference: Page """ The url that will allow to redirect user to payment provider page with transaction details. - - Added in Saleor 3.13. """ externalUrl: String! - """ - The amount related to this event. - - Added in Saleor 3.13. - """ + """The amount related to this event.""" amount: Money! - """ - The type of action related to this event. - - Added in Saleor 3.13. - """ + """The type of action related to this event.""" type: TransactionEventTypeEnum - """ - User or App that created the transaction event. - - Added in Saleor 3.13. - """ + """User or App that created the transaction event.""" createdBy: UserOrApp - """ - Idempotency key assigned to the event. - - Added in Saleor 3.14. - """ + """Idempotency key assigned to the event.""" idempotencyKey: String } @@ -13299,6 +12682,16 @@ enum TransactionEventTypeEnum @doc(category: "Payments") { union UserOrApp = User | App +""" +Represents a payment method used for a transaction. + +Added in Saleor 3.22. +""" +interface PaymentMethodDetails { + """Name of the payment method.""" + name: String! +} + """ Determine a current authorize status for checkout. @@ -13344,10 +12737,6 @@ enum CheckoutChargeStatusEnum @doc(category: "Checkout") { """ Represents a payment method stored for user (tokenized) in payment gateway. - -Added in Saleor 3.15. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. """ type StoredPaymentMethod @doc(category: "Payments") { """Stored payment method ID.""" @@ -13388,15 +12777,7 @@ enum TokenizedPaymentFlowEnum @doc(category: "Payments") { INTERACTIVE } -scalar JSON - -""" -Represents an problem in the checkout. - -Added in Saleor 3.15. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Represents an problem in the checkout.""" union CheckoutProblem = CheckoutLineProblemInsufficientStock | CheckoutLineProblemVariantNotAvailable type CheckoutCountableConnection @doc(category: "Checkout") { @@ -13475,7 +12856,7 @@ type Group implements Node @doc(category: "Users") { """ List of group users - + Requires one of the following permissions: MANAGE_STAFF. """ users: [User!] @@ -13488,22 +12869,10 @@ type Group implements Node @doc(category: "Users") { """ userCanManage: Boolean! - """ - List of channels the group has access to. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """List of channels the group has access to.""" accessibleChannels: [Channel!] - """ - Determine if the group have restricted access to channels. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Determine if the group have restricted access to channels.""" restrictedAccessToChannels: Boolean! } @@ -13537,7 +12906,6 @@ type CustomerEvent implements Node @doc(category: "Users") { orderLine: OrderLine } -"""An enumeration.""" enum CustomerEventsEnum @doc(category: "Users") { ACCOUNT_CREATED ACCOUNT_ACTIVATED @@ -13571,9 +12939,7 @@ type PaymentSource @doc(category: "Payments") { """ List of public metadata items. - - Added in Saleor 3.1. - + Can be accessed without permissions. """ metadata: [MetadataItem!]! @@ -13614,7 +12980,6 @@ type GiftCardSettings @doc(category: "Gift cards") { expiryPeriod: TimePeriod } -"""An enumeration.""" enum GiftCardSettingsExpiryTypeEnum @doc(category: "Gift cards") { NEVER_EXPIRE EXPIRY_PERIOD @@ -13628,7 +12993,6 @@ type TimePeriod { type: TimePeriodTypeEnum! } -"""An enumeration.""" enum TimePeriodTypeEnum { DAY WEEK @@ -13636,6 +13000,16 @@ enum TimePeriodTypeEnum { YEAR } +""" +Refund related settings from site settings. + +Added in Saleor 3.22. +""" +type RefundSettings @doc(category: "Orders") { + """Model type used for refund reasons.""" + reasonReferenceType: PageType +} + input ShippingZoneFilterInput @doc(category: "Shipping") { search: String channels: [ID!] @@ -13665,11 +13039,7 @@ input CategoryFilterInput @doc(category: "Products") { ids: [ID!] slugs: [String!] - """ - Filter by when was the most recent update. - - Added in Saleor 3.17. - """ + """Filter by when was the most recent update.""" updatedAt: DateTimeRangeInput } @@ -13688,12 +13058,8 @@ input CategorySortingInput @doc(category: "Products") { """Specifies the direction in which to sort categories.""" direction: OrderDirection! - """ - Specifies the channel in which to sort the data. - - DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. - """ - channel: String + """Specifies the channel in which to sort the data.""" + channel: String @deprecated(reason: "Use root-level channel argument instead.") """Sort categories by the selected field.""" field: CategorySortField! @@ -13717,12 +13083,8 @@ input CollectionFilterInput @doc(category: "Products") { ids: [ID!] slugs: [String!] - """ - Specifies the channel by which the data should be filtered. - - DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. - """ - channel: String + """Specifies the channel by which the data should be filtered.""" + channel: String @deprecated(reason: "Use root-level channel argument instead.") } enum CollectionPublished @doc(category: "Products") { @@ -13745,12 +13107,8 @@ input CollectionSortingInput @doc(category: "Products") { """Specifies the direction in which to sort collections.""" direction: OrderDirection! - """ - Specifies the channel in which to sort the data. - - DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. - """ - channel: String + """Specifies the channel in which to sort the data.""" + channel: String @deprecated(reason: "Use root-level channel argument instead.") """Sort collections by the selected field.""" field: CollectionSortField! @@ -13762,7 +13120,7 @@ enum CollectionSortField @doc(category: "Products") { """ Sort collections by availability. - + This option requires a channel filter to work as the values can vary between channels. """ AVAILABILITY @@ -13772,14 +13130,14 @@ enum CollectionSortField @doc(category: "Products") { """ Sort collections by publication date. - + This option requires a channel filter to work as the values can vary between channels. """ - PUBLICATION_DATE + PUBLICATION_DATE @deprecated(reason: "Use `PUBLISHED_AT` instead.") """ - Sort collections by publication date. - + Sort collections by published at. + This option requires a channel filter to work as the values can vary between channels. """ PUBLISHED_AT @@ -13824,63 +13182,60 @@ enum ProductTypeSortField @doc(category: "Products") { SHIPPING_REQUIRED } -input ProductVariantFilterInput @doc(category: "Products") { - search: String - sku: [String!] - metadata: [MetadataFilter!] - isPreorder: Boolean - updatedAt: DateTimeRangeInput -} - -input ProductVariantWhereInput @doc(category: "Products") { - metadata: [MetadataFilter!] - ids: [ID!] - - """List of conditions that must be met.""" - AND: [ProductVariantWhereInput!] +type PaymentCountableConnection @doc(category: "Payments") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [PaymentCountableEdge!]! - """A list of conditions of which at least one must be met.""" - OR: [ProductVariantWhereInput!] + """A total count of items in the collection.""" + totalCount: Int } -input ProductVariantSortingInput @doc(category: "Products") { - """Specifies the direction in which to sort productVariants.""" - direction: OrderDirection! +type PaymentCountableEdge @doc(category: "Payments") { + """The item at the end of the edge.""" + node: Payment! - """Sort productVariants by the selected field.""" - field: ProductVariantSortField! + """A cursor for use in pagination.""" + cursor: String! } -enum ProductVariantSortField @doc(category: "Products") { - """Sort products variants by last modified at.""" - LAST_MODIFIED_AT +input PaymentFilterInput @doc(category: "Payments") { + """Filter by ids.""" + ids: [ID!] + checkouts: [ID!] } -type PaymentCountableConnection @doc(category: "Payments") { +type TransactionCountableConnection @doc(category: "Payments") { """Pagination data for this connection.""" pageInfo: PageInfo! - edges: [PaymentCountableEdge!]! + edges: [TransactionCountableEdge!]! """A total count of items in the collection.""" totalCount: Int } -type PaymentCountableEdge @doc(category: "Payments") { +type TransactionCountableEdge @doc(category: "Payments") { """The item at the end of the edge.""" - node: Payment! + node: TransactionItem! """A cursor for use in pagination.""" cursor: String! } -input PaymentFilterInput @doc(category: "Payments") { - """ - Filter by ids. - - Added in Saleor 3.8. - """ +input TransactionWhereInput @doc(category: "Payments") { ids: [ID!] - checkouts: [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 @doc(category: "Pages") { @@ -13918,32 +13273,16 @@ enum PageSortField @doc(category: "Pages") { """Sort pages by visibility.""" VISIBILITY - """ - Sort pages by creation date. - - DEPRECATED: this field will be removed in Saleor 4.0. - """ - CREATION_DATE + """Sort pages by creation date.""" + CREATION_DATE @deprecated(reason: "Use `CREATED_AT` instead.") - """ - Sort pages by publication date. - - DEPRECATED: this field will be removed in Saleor 4.0. - """ - PUBLICATION_DATE + """Sort pages by publication date.""" + PUBLICATION_DATE @deprecated(reason: "Use `PUBLISHED_AT` instead.") - """ - Sort pages by publication date. - - DEPRECATED: this field will be removed in Saleor 4.0. - """ + """Sort pages by publication date.""" PUBLISHED_AT - """ - Sort pages by creation date. - - DEPRECATED: this field will be removed in Saleor 4.0. - """ + """Sort pages by creation date.""" CREATED_AT } @@ -13955,6 +13294,57 @@ input PageFilterInput @doc(category: "Pages") { slugs: [String!] } +input PageWhereInput @doc(category: "Pages") { + """Filter by metadata fields.""" + metadata: MetadataFilterInput + ids: [ID!] + + """Filter by page slug.""" + slug: StringFilterInput + + """Filter by page type.""" + pageType: GlobalIDFilterInput + + """Filter by attributes associated with the page.""" + attributes: [AssignedAttributeWhereInput!] + + """List of conditions that must be met.""" + AND: [PageWhereInput!] + + """A list of conditions of which at least one must be met.""" + 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". +""" +input MetadataFilterInput { + """ + Key to filter by. If not other fields provided - checking the existence of the key in metadata. + """ + key: String! + + """Value to filter by.""" + value: MetadataValueFilterInput +} + +"""Define the filtering options for metadata value fields.""" +input MetadataValueFilterInput { + """The value equal to.""" + eq: String + + """The value included in.""" + oneOf: [String!] +} + type PageTypeCountableConnection @doc(category: "Pages") { """Pagination data for this connection.""" pageInfo: PageInfo! @@ -13990,107 +13380,478 @@ enum PageTypeSortField @doc(category: "Pages") { input PageTypeFilterInput @doc(category: "Pages") { search: String - slugs: [String!] + slugs: [String!] +} + +type OrderEventCountableConnection @doc(category: "Orders") { + """Pagination data for this connection.""" + pageInfo: PageInfo! + edges: [OrderEventCountableEdge!]! + + """A total count of items in the collection.""" + totalCount: Int +} + +type OrderEventCountableEdge @doc(category: "Orders") { + """The item at the end of the edge.""" + node: OrderEvent! + + """A cursor for use in pagination.""" + cursor: String! +} + +input OrderSortingInput @doc(category: "Orders") { + """Specifies the direction in which to sort orders.""" + direction: OrderDirection! + + """Sort orders by the selected field.""" + field: OrderSortField! +} + +enum OrderSortField @doc(category: "Orders") { + """Sort orders by number.""" + NUMBER + + """ + Sort orders by rank. Note: This option is available only with the `search` filter. + """ + RANK + + """Sort orders by creation date""" + CREATION_DATE @deprecated(reason: "Use `CREATED_AT` instead.") + + """Sort orders by creation date.""" + CREATED_AT + + """Sort orders by last modified date.""" + LAST_MODIFIED_AT + + """Sort orders by customer.""" + CUSTOMER + + """Sort orders by payment status.""" + PAYMENT + + """Sort orders by fulfillment status.""" + FULFILLMENT_STATUS @deprecated(reason: "Use `STATUS` instead.") + + """ + Sort orders by order status. + + Added in Saleor 3.22. + """ + STATUS +} + +input OrderFilterInput @doc(category: "Orders") { + paymentStatus: [PaymentChargeStatusEnum!] + status: [OrderStatusFilter!] + customer: String + created: DateRangeInput + search: String + metadata: [MetadataFilter!] + channels: [ID!] + authorizeStatus: [OrderAuthorizeStatusEnum!] + chargeStatus: [OrderChargeStatusEnum!] + updatedAt: DateTimeRangeInput + isClickAndCollect: Boolean + isPreorder: Boolean + ids: [ID!] + checkoutTokens: [UUID!] + giftCardUsed: Boolean + giftCardBought: Boolean + numbers: [String!] + checkoutIds: [ID!] +} + +enum OrderStatusFilter @doc(category: "Orders") { + READY_TO_FULFILL + READY_TO_CAPTURE + UNFULFILLED + UNCONFIRMED + PARTIALLY_FULFILLED + FULFILLED + CANCELED +} + +input OrderWhereInput @doc(category: "Orders") { + """Filter by metadata fields.""" + metadata: MetadataFilterInput + ids: [ID!] + + """Filter by order number.""" + number: IntFilterInput + + """Filter by channel.""" + channelId: GlobalIDFilterInput + + """Filter order by created at date.""" + createdAt: DateTimeRangeInput + + """Filter order by updated at date.""" + updatedAt: DateTimeRangeInput + + """Filter by user.""" + user: GlobalIDFilterInput + + """Filter by user email.""" + userEmail: StringFilterInput + + """Filter by authorize status.""" + authorizeStatus: OrderAuthorizeStatusEnumFilterInput + + """Filter by charge status.""" + chargeStatus: OrderChargeStatusEnumFilterInput + + """Filter by order status.""" + status: OrderStatusEnumFilterInput + + """Filter by checkout token.""" + checkoutToken: UUIDFilterInput + + """Filter by checkout id.""" + checkoutId: GlobalIDFilterInput + + """ + Filter by whether the order uses the click and collect delivery method. + """ + isClickAndCollect: Boolean + + """Filter based on whether a gift card was used in the order.""" + isGiftCardUsed: Boolean + + """Filter based on whether the order includes a gift card purchase.""" + isGiftCardBought: Boolean + + """Filter by voucher code used in the order.""" + voucherCode: StringFilterInput + + """Filter by whether the order has any invoices.""" + hasInvoices: Boolean + + """ + Filter by invoice data associated with the order. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. + """ + invoices: [InvoiceFilterInput!] + + """Filter by whether the order has any fulfillments.""" + hasFulfillments: Boolean + + """ + Filter by fulfillment data associated with the order. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. + """ + fulfillments: [FulfillmentFilterInput!] + + """ + Filter by line items associated with the order. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. + """ + lines: [LinesFilterInput!] + + """Filter by number of lines in the order.""" + linesCount: IntFilterInput + + """ + Filter by transaction data associated with the order. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. + """ + transactions: [TransactionFilterInput!] + + """Filter by total gross amount of the order.""" + totalGross: PriceFilterInput + + """Filter by total net amount of the order.""" + totalNet: PriceFilterInput + + """Filter by the product type of related order lines.""" + productTypeId: GlobalIDFilterInput + + """ + Filter by order events. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. + """ + events: [OrderEventFilterInput!] + + """Filter by billing address of the order.""" + billingAddress: AddressFilterInput + + """Filter by shipping address of the order.""" + shippingAddress: AddressFilterInput + + """List of conditions that must be met.""" + AND: [OrderWhereInput!] + + """A list of conditions of which at least one must be met.""" + OR: [OrderWhereInput!] +} + +"""Define the filtering options for integer fields.""" +input IntFilterInput { + """The value equal to.""" + eq: Int + + """The value included in.""" + oneOf: [Int!] + + """The value in range.""" + range: IntRangeInput +} + +"""Filter by authorize status.""" +input OrderAuthorizeStatusEnumFilterInput @doc(category: "Orders") { + """The value equal to.""" + eq: OrderAuthorizeStatusEnum + + """The value included in.""" + oneOf: [OrderAuthorizeStatusEnum!] +} + +"""Filter by charge status.""" +input OrderChargeStatusEnumFilterInput @doc(category: "Orders") { + """The value equal to.""" + eq: OrderChargeStatusEnum + + """The value included in.""" + oneOf: [OrderChargeStatusEnum!] +} + +"""Filter by order status.""" +input OrderStatusEnumFilterInput @doc(category: "Orders") { + """The value equal to.""" + eq: OrderStatus + + """The value included in.""" + oneOf: [OrderStatus!] +} + +"""Define the filtering options for string fields.""" +input UUIDFilterInput { + """The value equal to.""" + eq: UUID + + """The value included in.""" + oneOf: [UUID!] +} + +"""Filter input for invoices.""" +input InvoiceFilterInput @doc(category: "Orders") { + """Filter invoices by creation date.""" + createdAt: DateTimeRangeInput +} + +"""Filter input for order fulfillments data.""" +input FulfillmentFilterInput @doc(category: "Orders") { + """Filter by fulfillment status.""" + status: FulfillmentStatusEnumFilterInput + + """Filter by metadata fields.""" + metadata: MetadataFilterInput + + """Filter by fulfillment warehouse.""" + warehouse: FulfillmentWarehouseFilterInput +} + +"""Filter by fulfillment status.""" +input FulfillmentStatusEnumFilterInput @doc(category: "Orders") { + """The value equal to.""" + eq: FulfillmentStatus + + """The value included in.""" + oneOf: [FulfillmentStatus!] +} + +"""Filter input for fulfillment warehouses.""" +input FulfillmentWarehouseFilterInput @doc(category: "Orders") { + """Filter fulfillments by warehouse ID.""" + id: GlobalIDFilterInput + + """Filter fulfillments by warehouse slug.""" + slug: StringFilterInput + + """Filter fulfillments by warehouse external reference.""" + externalReference: StringFilterInput +} + +"""Filter input for order lines data.""" +input LinesFilterInput @doc(category: "Orders") { + """Filter by metadata fields of order lines.""" + metadata: MetadataFilterInput +} + +"""Filter input for transactions.""" +input TransactionFilterInput @doc(category: "Orders") { + """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 +} + +input PaymentMethodDetailsFilterInput { + """Filter by payment method type used to pay for the order.""" + type: PaymentMethodTypeEnumFilterInput + + """ + Filter by card details used to pay for the order. Skips `type` filter if provided. + """ + card: PaymentMethodDetailsCardFilterInput +} + +input PaymentMethodTypeEnumFilterInput { + """The value equal to.""" + eq: PaymentMethodTypeEnum + + """The value included in.""" + 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") { + CARD + OTHER +} + +input PaymentMethodDetailsCardFilterInput { + """Filter by payment method brand used to pay for the order.""" + brand: StringFilterInput +} + +input PriceFilterInput { + """The currency of the price to filter by.""" + currency: String + + """The amount of the price to filter by.""" + amount: DecimalFilterInput! +} + +"""Filter input for order events data.""" +input OrderEventFilterInput @doc(category: "Orders") { + """Filter order events by date.""" + date: DateTimeRangeInput + + """Filter order events by type.""" + type: OrderEventTypeEnumFilterInput +} + +input OrderEventTypeEnumFilterInput { + """The value equal to.""" + eq: OrderEventsEnum + + """The value included in.""" + oneOf: [OrderEventsEnum!] +} + +"""Filtering options for addresses.""" +input AddressFilterInput @doc(category: "Users") { + phoneNumber: StringFilterInput + country: CountryCodeEnumFilterInput +} + +"""Filter by country code.""" +input CountryCodeEnumFilterInput @doc(category: "Users") { + """The value equal to.""" + eq: CountryCode + + """The value included in.""" + oneOf: [CountryCode!] + + """The value not included in.""" + notOneOf: [CountryCode!] +} + +input OrderDraftFilterInput @doc(category: "Orders") { + customer: String + created: DateRangeInput + search: String + metadata: [MetadataFilter!] + channels: [ID!] } -type OrderEventCountableConnection @doc(category: "Orders") { - """Pagination data for this connection.""" - pageInfo: PageInfo! - edges: [OrderEventCountableEdge!]! +input DraftOrderWhereInput @doc(category: "Orders") { + """Filter by metadata fields.""" + metadata: MetadataFilterInput + ids: [ID!] - """A total count of items in the collection.""" - totalCount: Int -} + """Filter by order number.""" + number: IntFilterInput -type OrderEventCountableEdge @doc(category: "Orders") { - """The item at the end of the edge.""" - node: OrderEvent! + """Filter by channel.""" + channelId: GlobalIDFilterInput - """A cursor for use in pagination.""" - cursor: String! -} + """Filter order by created at date.""" + createdAt: DateTimeRangeInput -input OrderSortingInput @doc(category: "Orders") { - """Specifies the direction in which to sort orders.""" - direction: OrderDirection! + """Filter order by updated at date.""" + updatedAt: DateTimeRangeInput - """Sort orders by the selected field.""" - field: OrderSortField! -} + """Filter by user.""" + user: GlobalIDFilterInput -enum OrderSortField @doc(category: "Orders") { - """Sort orders by number.""" - NUMBER + """Filter by user email.""" + userEmail: StringFilterInput + + """Filter by authorize status.""" + authorizeStatus: OrderAuthorizeStatusEnumFilterInput + + """Filter by charge status.""" + chargeStatus: OrderChargeStatusEnumFilterInput """ - Sort orders by rank. Note: This option is available only with the `search` filter. + Filter by whether the order uses the click and collect delivery method. """ - RANK + isClickAndCollect: Boolean + + """Filter by voucher code used in the order.""" + voucherCode: StringFilterInput """ - Sort orders by creation date. - - DEPRECATED: this field will be removed in Saleor 4.0. + Filter by line items associated with the order. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. """ - CREATION_DATE + lines: [LinesFilterInput!] + + """Filter by number of lines in the order.""" + linesCount: IntFilterInput """ - Sort orders by creation date. - - DEPRECATED: this field will be removed in Saleor 4.0. + Filter by transaction data associated with the order. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. """ - CREATED_AT + transactions: [TransactionFilterInput!] - """Sort orders by last modified at.""" - LAST_MODIFIED_AT + """Filter by total gross amount of the order.""" + totalGross: PriceFilterInput - """Sort orders by customer.""" - CUSTOMER + """Filter by total net amount of the order.""" + totalNet: PriceFilterInput - """Sort orders by payment.""" - PAYMENT + """Filter by the product type of related order lines.""" + productTypeId: GlobalIDFilterInput - """Sort orders by fulfillment status.""" - FULFILLMENT_STATUS -} + """ + Filter by order events. Each list item represents conditions that must be satisfied by a single object. The filter matches orders that have related objects meeting all specified groups of conditions. + """ + events: [OrderEventFilterInput!] -input OrderFilterInput @doc(category: "Orders") { - paymentStatus: [PaymentChargeStatusEnum!] - status: [OrderStatusFilter!] - customer: String - created: DateRangeInput - search: String - metadata: [MetadataFilter!] - channels: [ID!] - authorizeStatus: [OrderAuthorizeStatusEnum!] - chargeStatus: [OrderChargeStatusEnum!] - updatedAt: DateTimeRangeInput - isClickAndCollect: Boolean - isPreorder: Boolean - ids: [ID!] - checkoutTokens: [UUID!] - giftCardUsed: Boolean - giftCardBought: Boolean - numbers: [String!] - checkoutIds: [ID!] -} + """Filter by billing address of the order.""" + billingAddress: AddressFilterInput -enum OrderStatusFilter @doc(category: "Orders") { - READY_TO_FULFILL - READY_TO_CAPTURE - UNFULFILLED - UNCONFIRMED - PARTIALLY_FULFILLED - FULFILLED - CANCELED -} + """Filter by shipping address of the order.""" + shippingAddress: AddressFilterInput -input OrderDraftFilterInput @doc(category: "Orders") { - customer: String - created: DateRangeInput - search: String - metadata: [MetadataFilter!] - channels: [ID!] + """List of conditions that must be met.""" + AND: [DraftOrderWhereInput!] + + """A list of conditions of which at least one must be met.""" + OR: [DraftOrderWhereInput!] } type MenuCountableConnection @doc(category: "Menu") { @@ -14186,11 +13947,7 @@ enum GiftCardSortField @doc(category: "Gift cards") { """Sort gift cards by current balance.""" CURRENT_BALANCE - """ - Sort gift cards by created at. - - Added in Saleor 3.8. - """ + """Sort gift cards by created at.""" CREATED_AT } @@ -14277,7 +14034,6 @@ type ConfigurationItem { label: String } -"""An enumeration.""" enum ConfigurationTypeFieldEnum { STRING MULTILINE @@ -14370,12 +14126,8 @@ input SaleSortingInput @doc(category: "Discounts") { """Specifies the direction in which to sort sales.""" direction: OrderDirection! - """ - Specifies the channel in which to sort the data. - - DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. - """ - channel: String + """Specifies the channel in which to sort the data.""" + channel: String @deprecated(reason: "Use root-level channel argument instead.") """Sort sales by the selected field.""" field: SaleSortField! @@ -14393,7 +14145,7 @@ enum SaleSortField @doc(category: "Discounts") { """ Sort sales by value. - + This option requires a channel filter to work as the values can vary between channels. """ VALUE @@ -14401,10 +14153,10 @@ enum SaleSortField @doc(category: "Discounts") { """Sort sales by type.""" TYPE - """Sort sales by created at.""" + """Sort sales by creation date.""" CREATED_AT - """Sort sales by last modified at.""" + """Sort sales by last modification date.""" LAST_MODIFIED_AT } @@ -14445,28 +14197,20 @@ input VoucherSortingInput @doc(category: "Discounts") { """Specifies the direction in which to sort vouchers.""" direction: OrderDirection! - """ - Specifies the channel in which to sort the data. - - DEPRECATED: this field will be removed in Saleor 4.0. Use root-level channel argument instead. - """ - channel: String + """Specifies the channel in which to sort the data.""" + channel: String @deprecated(reason: "Use root-level channel argument instead.") """Sort vouchers by the selected field.""" field: VoucherSortField! } enum VoucherSortField { - """ - Sort vouchers by code. - - DEPRECATED: this field will be removed in Saleor 4.0. - """ - CODE + """Sort vouchers by code.""" + CODE @deprecated """ Sort vouchers by name. - + Added in Saleor 3.18. """ NAME @@ -14479,7 +14223,7 @@ enum VoucherSortField { """ Sort vouchers by value. - + This option requires a channel filter to work as the values can vary between channels. """ VALUE @@ -14492,7 +14236,7 @@ enum VoucherSortField { """ Sort vouchers by minimum spent amount. - + This option requires a channel filter to work as the values can vary between channels. """ MINIMUM_SPENT_AMOUNT @@ -14500,10 +14244,6 @@ enum VoucherSortField { """ Represents the promotion that allow creating discounts based on given conditions, and is visible to all the customers. - -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. """ type Promotion implements Node & ObjectWithMetadata @doc(category: "Discounts") { id: ID! @@ -14513,17 +14253,13 @@ type Promotion implements Node & ObjectWithMetadata @doc(category: "Discounts") """ A single key from private metadata. Requires staff permissions to access. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ privateMetafield(key: String!): String """ Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ privateMetafields(keys: [String!]): Metadata @@ -14532,17 +14268,13 @@ type Promotion implements Node & ObjectWithMetadata @doc(category: "Discounts") """ A single key from public metadata. - + Tip: Use GraphQL aliases to fetch multiple keys. - - Added in Saleor 3.3. """ metafield(key: String!): String """ Public metadata. Use `keys` to control which fields you want to include. The default is to include everything. - - Added in Saleor 3.3. """ metafields(keys: [String!]): Metadata @@ -14551,9 +14283,9 @@ type Promotion implements Node & ObjectWithMetadata @doc(category: "Discounts") """ The type of the promotion. Implicate if the discount is applied on catalogue or order level. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ type: PromotionTypeEnum @@ -14586,7 +14318,6 @@ type Promotion implements Node & ObjectWithMetadata @doc(category: "Discounts") events: [PromotionEvent!] } -"""An enumeration.""" enum PromotionTypeEnum @doc(category: "Discounts") { CATALOGUE ORDER @@ -14594,10 +14325,6 @@ enum PromotionTypeEnum @doc(category: "Discounts") { """ Represents the promotion rule that specifies the conditions that must be met to apply the promotion discount. - -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. """ type PromotionRule implements Node @doc(category: "Discounts") { id: ID! @@ -14613,16 +14340,16 @@ type PromotionRule implements Node @doc(category: "Discounts") { """ List of channels where the rule applies. - + Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. """ channels: [Channel!] """ The reward value of the promotion rule. Defines the discount value applied when the rule conditions are met. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ rewardValue: PositiveDecimal @@ -14632,9 +14359,9 @@ type PromotionRule implements Node @doc(category: "Discounts") { """ The type of the predicate that must be met to apply the reward. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ predicateType: PromotionTypeEnum @@ -14644,18 +14371,18 @@ type PromotionRule implements Node @doc(category: "Discounts") { """ The checkout/order predicate that must be met to apply the rule reward. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ orderPredicate: JSON """ The reward type of the promotion rule. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ rewardType: RewardTypeEnum @@ -14668,30 +14395,28 @@ type PromotionRule implements Node @doc(category: "Discounts") { """ Product variant IDs available as a gift to choose. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ giftIds: [ID!] """ Defines the maximum number of gifts to choose from the gifts list. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ giftsLimit: Int } -"""An enumeration.""" enum RewardValueTypeEnum @doc(category: "Discounts") { FIXED PERCENTAGE } -"""An enumeration.""" enum RewardTypeEnum @doc(category: "Discounts") { SUBTOTAL_DISCOUNT GIFT @@ -14699,13 +14424,7 @@ enum RewardTypeEnum @doc(category: "Discounts") { union PromotionEvent = PromotionCreatedEvent | PromotionUpdatedEvent | PromotionStartedEvent | PromotionEndedEvent | PromotionRuleCreatedEvent | PromotionRuleUpdatedEvent | PromotionRuleDeletedEvent -""" -History log of the promotion created event. - -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""History log of the promotion created event.""" type PromotionCreatedEvent implements Node & PromotionEventInterface @doc(category: "Discounts") { id: ID! @@ -14716,8 +14435,8 @@ type PromotionCreatedEvent implements Node & PromotionEventInterface @doc(catego type: PromotionEventsEnum! """ - User or App that created the promotion event. - + User or App that created the promotion event. + Requires one of the following permissions: MANAGE_STAFF, MANAGE_APPS, OWNER. """ createdBy: UserOrApp @@ -14733,14 +14452,13 @@ interface PromotionEventInterface { type: PromotionEventsEnum! """ - User or App that created the promotion event. - + User or App that created the promotion event. + Requires one of the following permissions: MANAGE_STAFF, MANAGE_APPS, OWNER. """ createdBy: UserOrApp } -"""An enumeration.""" enum PromotionEventsEnum @doc(category: "Discounts") { PROMOTION_CREATED PROMOTION_UPDATED @@ -14751,13 +14469,7 @@ enum PromotionEventsEnum @doc(category: "Discounts") { RULE_DELETED } -""" -History log of the promotion updated event. - -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""History log of the promotion updated event.""" type PromotionUpdatedEvent implements Node & PromotionEventInterface @doc(category: "Discounts") { id: ID! @@ -14768,20 +14480,14 @@ type PromotionUpdatedEvent implements Node & PromotionEventInterface @doc(catego type: PromotionEventsEnum! """ - User or App that created the promotion event. - + User or App that created the promotion event. + Requires one of the following permissions: MANAGE_STAFF, MANAGE_APPS, OWNER. """ createdBy: UserOrApp } -""" -History log of the promotion started event. - -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""History log of the promotion started event.""" type PromotionStartedEvent implements Node & PromotionEventInterface @doc(category: "Discounts") { id: ID! @@ -14792,20 +14498,14 @@ type PromotionStartedEvent implements Node & PromotionEventInterface @doc(catego type: PromotionEventsEnum! """ - User or App that created the promotion event. - + User or App that created the promotion event. + Requires one of the following permissions: MANAGE_STAFF, MANAGE_APPS, OWNER. """ createdBy: UserOrApp } -""" -History log of the promotion ended event. - -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""History log of the promotion ended event.""" type PromotionEndedEvent implements Node & PromotionEventInterface @doc(category: "Discounts") { id: ID! @@ -14816,20 +14516,14 @@ type PromotionEndedEvent implements Node & PromotionEventInterface @doc(category type: PromotionEventsEnum! """ - User or App that created the promotion event. - + User or App that created the promotion event. + Requires one of the following permissions: MANAGE_STAFF, MANAGE_APPS, OWNER. """ createdBy: UserOrApp } -""" -History log of the promotion rule created event. - -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""History log of the promotion rule created event.""" type PromotionRuleCreatedEvent implements Node & PromotionEventInterface & PromotionRuleEventInterface @doc(category: "Discounts") { id: ID! @@ -14840,8 +14534,8 @@ type PromotionRuleCreatedEvent implements Node & PromotionEventInterface & Promo type: PromotionEventsEnum! """ - User or App that created the promotion event. - + User or App that created the promotion event. + Requires one of the following permissions: MANAGE_STAFF, MANAGE_APPS, OWNER. """ createdBy: UserOrApp @@ -14850,25 +14544,13 @@ type PromotionRuleCreatedEvent implements Node & PromotionEventInterface & Promo ruleId: String } -""" -History log of the promotion event related to rule. - -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""History log of the promotion event related to rule.""" interface PromotionRuleEventInterface { """The rule ID associated with the promotion event.""" ruleId: String } -""" -History log of the promotion rule created event. - -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""History log of the promotion rule created event.""" type PromotionRuleUpdatedEvent implements Node & PromotionEventInterface & PromotionRuleEventInterface @doc(category: "Discounts") { id: ID! @@ -14879,8 +14561,8 @@ type PromotionRuleUpdatedEvent implements Node & PromotionEventInterface & Promo type: PromotionEventsEnum! """ - User or App that created the promotion event. - + User or App that created the promotion event. + Requires one of the following permissions: MANAGE_STAFF, MANAGE_APPS, OWNER. """ createdBy: UserOrApp @@ -14889,13 +14571,7 @@ type PromotionRuleUpdatedEvent implements Node & PromotionEventInterface & Promo ruleId: String } -""" -History log of the promotion rule created event. - -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""History log of the promotion rule created event.""" type PromotionRuleDeletedEvent implements Node & PromotionEventInterface & PromotionRuleEventInterface @doc(category: "Discounts") { id: ID! @@ -14906,8 +14582,8 @@ type PromotionRuleDeletedEvent implements Node & PromotionEventInterface & Promo type: PromotionEventsEnum! """ - User or App that created the promotion event. - + User or App that created the promotion event. + Requires one of the following permissions: MANAGE_STAFF, MANAGE_APPS, OWNER. """ createdBy: UserOrApp @@ -14981,7 +14657,7 @@ enum PromotionSortField @doc(category: "Discounts") { """Sort promotions by end date.""" END_DATE - """Sort promotions by created at.""" + """Sort promotions by creation date.""" CREATED_AT } @@ -15040,7 +14716,6 @@ type ExportEvent implements Node { message: String! } -"""An enumeration.""" enum ExportEventsEnum { EXPORT_PENDING EXPORT_SUCCESS @@ -15086,7 +14761,7 @@ input ExportFileSortingInput { enum ExportFileSortField { STATUS CREATED_AT - UPDATED_AT + UPDATED_AT @deprecated(reason: "Use `LAST_MODIFIED_AT` instead.") LAST_MODIFIED_AT } @@ -15199,13 +14874,7 @@ type AppInstallation implements Node & Job @doc(category: "Apps") { """The URL address of manifest for the app installation.""" manifestUrl: String! - """ - App's brand data. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """App's brand data.""" brand: AppBrand } @@ -15266,8 +14935,25 @@ type AppExtensionCountableEdge @doc(category: "Apps") { } input AppExtensionFilterInput @doc(category: "Apps") { - mount: [AppExtensionMountEnum!] - target: AppExtensionTargetEnum + """DEPRECATED: Use `mountName` instead.""" + mount: [AppExtensionMountEnum!] @deprecated + + """DEPRECATED: Use `targetName` instead.""" + target: AppExtensionTargetEnum @deprecated + + """ + Plain-text mount name (case insensitive) + + Added in Saleor 3.22. + """ + mountName: [String!] + + """ + Plain-text target name (case insensitive) + + Added in Saleor 3.22. + """ + targetName: String } """Represents address validation rules for a country.""" @@ -15280,9 +14966,9 @@ type AddressValidationData @doc(category: "Users") { """ The address format of the address validation rule. - + Many fields in the JSON refer to address fields by one-letter abbreviations. These are defined as follows: - + - `N`: Name - `O`: Organization - `A`: Street Address Line(s) @@ -15291,16 +14977,16 @@ type AddressValidationData @doc(category: "Users") { - `S`: Administrative area such as a state, province, island etc - `Z`: Zip or postal code - `X`: Sorting code - + [Click here for more information.](https://github.com/google/libaddressinput/wiki/AddressValidationMetadata) """ addressFormat: String! """ The latin address format of the address validation rule. - + Many fields in the JSON refer to address fields by one-letter abbreviations. These are defined as follows: - + - `N`: Name - `O`: Organization - `A`: Street Address Line(s) @@ -15309,7 +14995,7 @@ type AddressValidationData @doc(category: "Users") { - `S`: Administrative area such as a state, province, island etc - `Z`: Zip or postal code - `X`: Sorting code - + [Click here for more information.](https://github.com/google/libaddressinput/wiki/AddressValidationMetadata) """ addressLatinFormat: String! @@ -15392,13 +15078,48 @@ input CustomerFilterInput @doc(category: "Users") { search: String metadata: [MetadataFilter!] - """ - Filter by ids. - - Added in Saleor 3.8. - """ + """Filter by ids.""" + ids: [ID!] + updatedAt: DateTimeRangeInput +} + +input CustomerWhereInput @doc(category: "Users") { + """Filter by metadata fields.""" + metadata: MetadataFilterInput ids: [ID!] + + """Filter by email address.""" + email: StringFilterInput + + """Filter by first name.""" + firstName: StringFilterInput + + """Filter by last name.""" + lastName: StringFilterInput + + """Filter by whether the user is active.""" + isActive: Boolean + + """Filter by date joined.""" + dateJoined: DateTimeRangeInput + + """Filter by last updated date.""" updatedAt: DateTimeRangeInput + + """Filter by date when orders were placed.""" + placedOrdersAt: DateTimeRangeInput + + """Filter by addresses data associated with user.""" + addresses: AddressFilterInput + + """Filter by number of orders placed by the user.""" + numberOfOrders: IntFilterInput + + """List of conditions that must be met.""" + AND: [CustomerWhereInput!] + + """A list of conditions of which at least one must be met.""" + OR: [CustomerWhereInput!] } input UserSortingInput @doc(category: "Users") { @@ -15482,8 +15203,8 @@ enum StaffMemberStatus @doc(category: "Users") { type Mutation { """ - Creates a new webhook subscription. - + Creates a new webhook subscription. + Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP. """ webhookCreate( @@ -15492,8 +15213,8 @@ type Mutation { ): WebhookCreate @doc(category: "Webhooks") """ - Delete a webhook. Before the deletion, the webhook is deactivated to pause any deliveries that are already scheduled. The deletion might fail if delivery is in progress. In such a case, the webhook is not deleted but remains deactivated. - + 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. + Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP. """ webhookDelete( @@ -15502,8 +15223,8 @@ type Mutation { ): WebhookDelete @doc(category: "Webhooks") """ - Updates a webhook subscription. - + Updates a webhook subscription. + Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP. """ webhookUpdate( @@ -15515,8 +15236,8 @@ type Mutation { ): WebhookUpdate @doc(category: "Webhooks") """ - Retries event delivery. - + Retries event delivery. + Requires one of the following permissions: MANAGE_APPS. """ eventDeliveryRetry( @@ -15526,11 +15247,7 @@ type Mutation { """ Performs a dry run of a webhook event. Supports a single event (the first, if multiple provided in the `query`). Requires permission relevant to processed event. - - Added in Saleor 3.11. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: AUTHENTICATED_STAFF_USER. """ webhookDryRun( @@ -15543,11 +15260,7 @@ type Mutation { """ Trigger a webhook event. Supports a single event (the first, if multiple provided in the `webhook.subscription_query`). Requires permission relevant to processed event. Successfully delivered webhook returns `delivery` with status='PENDING' and empty payload. - - Added in Saleor 3.11. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: AUTHENTICATED_STAFF_USER. """ webhookTrigger( @@ -15559,8 +15272,8 @@ type Mutation { ): WebhookTrigger @doc(category: "Webhooks") """ - Creates new warehouse. - + Creates a new warehouse. + Requires one of the following permissions: MANAGE_PRODUCTS. """ createWarehouse( @@ -15569,16 +15282,12 @@ type Mutation { ): WarehouseCreate @doc(category: "Products") """ - Updates given warehouse. - + Updates given warehouse. + Requires one of the following permissions: MANAGE_PRODUCTS. """ updateWarehouse( - """ - External reference of a warehouse. - - Added in Saleor 3.16. - """ + """External reference of a warehouse.""" externalReference: String """ID of a warehouse to update.""" @@ -15589,8 +15298,8 @@ type Mutation { ): WarehouseUpdate @doc(category: "Products") """ - Deletes selected warehouse. - + Deletes selected warehouse. + Requires one of the following permissions: MANAGE_PRODUCTS. """ deleteWarehouse( @@ -15599,8 +15308,8 @@ type Mutation { ): WarehouseDelete @doc(category: "Products") """ - Add shipping zone to given warehouse. - + Add shipping zone to given warehouse. + Requires one of the following permissions: MANAGE_PRODUCTS. """ assignWarehouseShippingZone( @@ -15612,8 +15321,8 @@ type Mutation { ): WarehouseShippingZoneAssign @doc(category: "Products") """ - Remove shipping zone from given warehouse. - + Remove shipping zone from given warehouse. + Requires one of the following permissions: MANAGE_PRODUCTS. """ unassignWarehouseShippingZone( @@ -15625,10 +15334,8 @@ type Mutation { ): WarehouseShippingZoneUnassign @doc(category: "Products") """ - Create a tax class. - - Added in Saleor 3.9. - + Creates a tax class. + Requires one of the following permissions: MANAGE_TAXES. """ taxClassCreate( @@ -15637,10 +15344,8 @@ type Mutation { ): TaxClassCreate @doc(category: "Taxes") """ - Delete a tax class. After deleting the tax class any products, product types or shipping methods using it are updated to use the default tax class. - - Added in Saleor 3.9. - + 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. + Requires one of the following permissions: MANAGE_TAXES. """ taxClassDelete( @@ -15649,10 +15354,8 @@ type Mutation { ): TaxClassDelete @doc(category: "Taxes") """ - Update a tax class. - - Added in Saleor 3.9. - + Updates a tax class. + Requires one of the following permissions: MANAGE_TAXES. """ taxClassUpdate( @@ -15664,10 +15367,8 @@ type Mutation { ): TaxClassUpdate @doc(category: "Taxes") """ - Update tax configuration for a channel. - - Added in Saleor 3.9. - + Updates tax configuration for a channel. + Requires one of the following permissions: MANAGE_TAXES. """ taxConfigurationUpdate( @@ -15679,10 +15380,8 @@ type Mutation { ): TaxConfigurationUpdate @doc(category: "Taxes") """ - Update tax class rates for a specific country. - - Added in Saleor 3.9. - + Updates tax class rates for a specific country. + Requires one of the following permissions: MANAGE_TAXES. """ taxCountryConfigurationUpdate( @@ -15697,9 +15396,7 @@ type Mutation { """ Remove all tax class rates for a specific country. - - Added in Saleor 3.9. - + Requires one of the following permissions: MANAGE_TAXES. """ taxCountryConfigurationDelete( @@ -15709,9 +15406,7 @@ type Mutation { """ Exempt checkout or order from charging the taxes. When tax exemption is enabled, taxes won't be charged for the checkout or order. Taxes may still be calculated in cases when product prices are entered with the tax included and the net price needs to be known. - - Added in Saleor 3.8. - + Requires one of the following permissions: MANAGE_TAXES. """ taxExemptionManage( @@ -15724,13 +15419,9 @@ type Mutation { """ 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. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_PRODUCTS. - + Triggers the following webhook events: - PRODUCT_VARIANT_STOCK_UPDATED (async): A product variant stock details were updated. """ @@ -15743,8 +15434,8 @@ type Mutation { ): StockBulkUpdate @doc(category: "Products") @webhookEventsInfo(asyncEvents: [PRODUCT_VARIANT_STOCK_UPDATED], syncEvents: []) """ - Creates a new staff notification recipient. - + Creates a new staff notification recipient. + Requires one of the following permissions: MANAGE_SETTINGS. """ staffNotificationRecipientCreate( @@ -15753,8 +15444,8 @@ type Mutation { ): StaffNotificationRecipientCreate @doc(category: "Users") """ - Updates a staff notification recipient. - + Updates a staff notification recipient. + Requires one of the following permissions: MANAGE_SETTINGS. """ staffNotificationRecipientUpdate( @@ -15766,8 +15457,8 @@ type Mutation { ): StaffNotificationRecipientUpdate @doc(category: "Users") """ - Delete staff notification recipient. - + Deletes staff notification recipient. + Requires one of the following permissions: MANAGE_SETTINGS. """ staffNotificationRecipientDelete( @@ -15777,21 +15468,19 @@ type Mutation { """ Updates site domain of the shop. - - DEPRECATED: this mutation will be removed in Saleor 4.0. Use `PUBLIC_URL` environment variable instead. - + Requires one of the following permissions: MANAGE_SETTINGS. """ shopDomainUpdate( """Fields required to update site.""" input: SiteDomainInput - ): ShopDomainUpdate @doc(category: "Shop") @deprecated(reason: "\\n\\nDEPRECATED: this mutation will be removed in Saleor 4.0. Use `PUBLIC_URL` environment variable instead.") + ): ShopDomainUpdate @doc(category: "Shop") @deprecated(reason: "Use `PUBLIC_URL` environment variable instead.") """ - Updates shop settings. - + Updates shop settings. + 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. """ @@ -15801,15 +15490,15 @@ type Mutation { ): ShopSettingsUpdate @doc(category: "Shop") @webhookEventsInfo(asyncEvents: [SHOP_METADATA_UPDATED], syncEvents: []) """ - Fetch tax rates. - + Fetch tax rates. + Requires one of the following permissions: MANAGE_SETTINGS. """ - shopFetchTaxRates: ShopFetchTaxRates @doc(category: "Shop") @deprecated(reason: "\\n\\nDEPRECATED: this mutation will be removed in Saleor 4.0.") + shopFetchTaxRates: ShopFetchTaxRates @doc(category: "Shop") @deprecated """ - Creates/updates translations for shop settings. - + Creates/updates translations for shop settings. + Requires one of the following permissions: MANAGE_TRANSLATIONS. """ shopSettingsTranslate( @@ -15821,8 +15510,8 @@ type Mutation { ): ShopSettingsTranslate @doc(category: "Shop") """ - Update the shop's address. If the `null` value is passed, the currently selected address will be deleted. - + Update the shop's address. If the `null` value is passed, the currently selected address will be deleted. + Requires one of the following permissions: MANAGE_SETTINGS. """ shopAddressUpdate( @@ -15831,18 +15520,18 @@ type Mutation { ): ShopAddressUpdate @doc(category: "Shop") """ - Update shop order settings across all channels. Returns `orderSettings` for the first `channel` in alphabetical order. - + Update shop order settings across all channels. Returns `orderSettings` for the first `channel` in alphabetical order. + Requires one of the following permissions: MANAGE_ORDERS. """ orderSettingsUpdate( """Fields required to update shop order settings.""" input: OrderSettingsUpdateInput! - ): OrderSettingsUpdate @doc(category: "Orders") @deprecated(reason: "\\n\\nDEPRECATED: this mutation will be removed in Saleor 4.0. Use `channelUpdate` mutation instead.") + ): OrderSettingsUpdate @doc(category: "Orders") @deprecated(reason: "Use `channelUpdate` mutation instead.") """ - Update gift card settings. - + Update gift card settings. + Requires one of the following permissions: MANAGE_GIFT_CARD. """ giftCardSettingsUpdate( @@ -15851,8 +15540,29 @@ type Mutation { ): GiftCardSettingsUpdate @doc(category: "Gift cards") """ - Manage shipping method's availability in channels. - + Update refund settings across all channels. + + Added in Saleor 3.22. + + Requires one of the following permissions: MANAGE_SETTINGS. + """ + refundSettingsUpdate( + """Fields required to update refund settings.""" + input: RefundSettingsUpdateInput! + ): RefundSettingsUpdate @doc(category: "Shop") + + """ + 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. + + Added in Saleor 3.22. + + Requires one of the following permissions: MANAGE_SETTINGS. + """ + refundReasonReferenceClear: RefundReasonReferenceTypeClear @doc(category: "Orders") + + """ + Manage shipping method's availability in channels. + Requires one of the following permissions: MANAGE_SHIPPING. """ shippingMethodChannelListingUpdate( @@ -15864,8 +15574,8 @@ type Mutation { ): ShippingMethodChannelListingUpdate @doc(category: "Shipping") """ - Creates a new shipping price. - + Creates a new shipping price. + Requires one of the following permissions: MANAGE_SHIPPING. """ shippingPriceCreate( @@ -15874,8 +15584,8 @@ type Mutation { ): ShippingPriceCreate @doc(category: "Shipping") """ - Deletes a shipping price. - + Deletes a shipping price. + Requires one of the following permissions: MANAGE_SHIPPING. """ shippingPriceDelete( @@ -15884,8 +15594,8 @@ type Mutation { ): ShippingPriceDelete @doc(category: "Shipping") """ - Deletes shipping prices. - + Deletes shipping prices. + Requires one of the following permissions: MANAGE_SHIPPING. """ shippingPriceBulkDelete( @@ -15894,8 +15604,8 @@ type Mutation { ): ShippingPriceBulkDelete @doc(category: "Shipping") """ - Updates a new shipping price. - + Updates a new shipping price. + Requires one of the following permissions: MANAGE_SHIPPING. """ shippingPriceUpdate( @@ -15907,8 +15617,8 @@ type Mutation { ): ShippingPriceUpdate @doc(category: "Shipping") """ - Creates/updates translations for a shipping method. - + Creates/updates translations for a shipping method. + Requires one of the following permissions: MANAGE_TRANSLATIONS. """ shippingPriceTranslate( @@ -15923,8 +15633,8 @@ type Mutation { ): ShippingPriceTranslate @doc(category: "Shipping") """ - Exclude products from shipping price. - + Exclude products from shipping price. + Requires one of the following permissions: MANAGE_SHIPPING. """ shippingPriceExcludeProducts( @@ -15936,8 +15646,8 @@ type Mutation { ): ShippingPriceExcludeProducts @doc(category: "Shipping") """ - Remove product from excluded list for shipping price. - + Remove product from excluded list for shipping price. + Requires one of the following permissions: MANAGE_SHIPPING. """ shippingPriceRemoveProductFromExclude( @@ -15949,8 +15659,8 @@ type Mutation { ): ShippingPriceRemoveProductFromExclude @doc(category: "Shipping") """ - Creates a new shipping zone. - + Creates a new shipping zone. + Requires one of the following permissions: MANAGE_SHIPPING. """ shippingZoneCreate( @@ -15959,8 +15669,8 @@ type Mutation { ): ShippingZoneCreate @doc(category: "Shipping") """ - Deletes a shipping zone. - + Deletes a shipping zone. + Requires one of the following permissions: MANAGE_SHIPPING. """ shippingZoneDelete( @@ -15969,8 +15679,8 @@ type Mutation { ): ShippingZoneDelete @doc(category: "Shipping") """ - Deletes shipping zones. - + Deletes shipping zones. + Requires one of the following permissions: MANAGE_SHIPPING. """ shippingZoneBulkDelete( @@ -15979,8 +15689,8 @@ type Mutation { ): ShippingZoneBulkDelete @doc(category: "Shipping") """ - Updates a new shipping zone. - + Updates a new shipping zone. + Requires one of the following permissions: MANAGE_SHIPPING. """ shippingZoneUpdate( @@ -15992,8 +15702,8 @@ type Mutation { ): ShippingZoneUpdate @doc(category: "Shipping") """ - Assign attributes to a given product type. - + Assign attributes to a given product type. + Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. """ productAttributeAssign( @@ -16006,9 +15716,7 @@ type Mutation { """ Update attributes assigned to product variant for given product type. - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. """ productAttributeAssignmentUpdate( @@ -16020,8 +15728,8 @@ type Mutation { ): ProductAttributeAssignmentUpdate @doc(category: "Products") """ - Un-assign attributes from a given product type. - + Un-assign attributes from a given product type. + Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. """ productAttributeUnassign( @@ -16033,8 +15741,8 @@ type Mutation { ): ProductAttributeUnassign @doc(category: "Products") """ - Creates a new category. - + Creates a new category. + Requires one of the following permissions: MANAGE_PRODUCTS. """ categoryCreate( @@ -16048,8 +15756,8 @@ type Mutation { ): CategoryCreate @doc(category: "Products") """ - Deletes a category. - + Deletes a category. + Requires one of the following permissions: MANAGE_PRODUCTS. """ categoryDelete( @@ -16058,8 +15766,8 @@ type Mutation { ): CategoryDelete @doc(category: "Products") """ - Deletes categories. - + Deletes categories. + Requires one of the following permissions: MANAGE_PRODUCTS. """ categoryBulkDelete( @@ -16068,8 +15776,8 @@ type Mutation { ): CategoryBulkDelete @doc(category: "Products") """ - Updates a category. - + Updates a category. + Requires one of the following permissions: MANAGE_PRODUCTS. """ categoryUpdate( @@ -16081,8 +15789,8 @@ type Mutation { ): CategoryUpdate @doc(category: "Products") """ - Creates/updates translations for a category. - + Creates/updates translations for a category. + Requires one of the following permissions: MANAGE_TRANSLATIONS. """ categoryTranslate( @@ -16097,8 +15805,8 @@ type Mutation { ): CategoryTranslate @doc(category: "Products") """ - Adds products to a collection. - + Adds products to a collection. + Requires one of the following permissions: MANAGE_PRODUCTS. """ collectionAddProducts( @@ -16110,8 +15818,8 @@ type Mutation { ): CollectionAddProducts @doc(category: "Products") """ - Creates a new collection. - + Creates a new collection. + Requires one of the following permissions: MANAGE_PRODUCTS. """ collectionCreate( @@ -16120,8 +15828,8 @@ type Mutation { ): CollectionCreate @doc(category: "Products") """ - Deletes a collection. - + Deletes a collection. + Requires one of the following permissions: MANAGE_PRODUCTS. """ collectionDelete( @@ -16130,8 +15838,8 @@ type Mutation { ): CollectionDelete @doc(category: "Products") """ - Reorder the products of a collection. - + Reorder the products of a collection. + Requires one of the following permissions: MANAGE_PRODUCTS. """ collectionReorderProducts( @@ -16143,8 +15851,8 @@ type Mutation { ): CollectionReorderProducts @doc(category: "Products") """ - Deletes collections. - + Deletes collections. + Requires one of the following permissions: MANAGE_PRODUCTS. """ collectionBulkDelete( @@ -16153,8 +15861,8 @@ type Mutation { ): CollectionBulkDelete @doc(category: "Products") """ - Remove products from a collection. - + Remove products from a collection. + Requires one of the following permissions: MANAGE_PRODUCTS. """ collectionRemoveProducts( @@ -16166,8 +15874,8 @@ type Mutation { ): CollectionRemoveProducts @doc(category: "Products") """ - Updates a collection. - + Updates a collection. + Requires one of the following permissions: MANAGE_PRODUCTS. """ collectionUpdate( @@ -16179,8 +15887,8 @@ type Mutation { ): CollectionUpdate @doc(category: "Products") """ - Creates/updates translations for a collection. - + Creates/updates translations for a collection. + Requires one of the following permissions: MANAGE_TRANSLATIONS. """ collectionTranslate( @@ -16195,8 +15903,8 @@ type Mutation { ): CollectionTranslate @doc(category: "Products") """ - Manage collection's availability in channels. - + Manage collection's availability in channels. + Requires one of the following permissions: MANAGE_PRODUCTS. """ collectionChannelListingUpdate( @@ -16208,8 +15916,8 @@ type Mutation { ): CollectionChannelListingUpdate @doc(category: "Products") """ - Creates a new product. - + Creates a new product. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productCreate( @@ -16218,16 +15926,12 @@ type Mutation { ): ProductCreate @doc(category: "Products") """ - Deletes a product. - + Deletes a product. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productDelete( - """ - External ID of a product to delete. - - Added in Saleor 3.10. - """ + """External ID of a product to delete.""" externalReference: String """ID of a product to delete.""" @@ -16236,11 +15940,7 @@ type Mutation { """ Creates products. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_PRODUCTS. """ productBulkCreate( @@ -16252,8 +15952,8 @@ type Mutation { ): ProductBulkCreate @doc(category: "Products") """ - Deletes products. - + Deletes products. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productBulkDelete( @@ -16262,16 +15962,12 @@ type Mutation { ): ProductBulkDelete @doc(category: "Products") """ - Updates an existing product. - + Updates an existing product. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productUpdate( - """ - External ID of a product to update. - - Added in Saleor 3.10. - """ + """External ID of a product to update.""" externalReference: String """ID of a product to update.""" @@ -16283,13 +15979,9 @@ type Mutation { """ Creates/updates translations for products. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_TRANSLATIONS. - + Triggers the following webhook events: - TRANSLATION_CREATED (async): Called when a translation was created. - TRANSLATION_UPDATED (async): Called when a translation was updated. @@ -16303,8 +15995,8 @@ type Mutation { ): ProductBulkTranslate @doc(category: "Products") @webhookEventsInfo(asyncEvents: [TRANSLATION_CREATED, TRANSLATION_UPDATED], syncEvents: []) """ - Creates/updates translations for a product. - + Creates/updates translations for a product. + Requires one of the following permissions: MANAGE_TRANSLATIONS. """ productTranslate( @@ -16319,8 +16011,8 @@ type Mutation { ): ProductTranslate @doc(category: "Products") """ - Manage product's availability in channels. - + Manage product's availability in channels. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productChannelListingUpdate( @@ -16332,8 +16024,8 @@ type Mutation { ): ProductChannelListingUpdate @doc(category: "Products") """ - Create a media object (image or video URL) associated with product. For image, this mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec - + Create a media object (image or video URL) associated with product. For image, this mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec + Requires one of the following permissions: MANAGE_PRODUCTS. """ productMediaCreate( @@ -16342,8 +16034,8 @@ type Mutation { ): ProductMediaCreate @doc(category: "Products") """ - Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook. - + Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productVariantReorder( @@ -16355,8 +16047,8 @@ type Mutation { ): ProductVariantReorder @doc(category: "Products") """ - Deletes a product media. - + Deletes a product media. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productMediaDelete( @@ -16365,8 +16057,8 @@ type Mutation { ): ProductMediaDelete @doc(category: "Products") """ - Deletes product media. - + Deletes product media. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productMediaBulkDelete( @@ -16375,8 +16067,8 @@ type Mutation { ): ProductMediaBulkDelete @doc(category: "Products") """ - Changes ordering of the product media. - + Changes ordering of the product media. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productMediaReorder( @@ -16388,8 +16080,8 @@ type Mutation { ): ProductMediaReorder @doc(category: "Products") """ - Updates a product media. - + Updates a product media. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productMediaUpdate( @@ -16401,8 +16093,8 @@ type Mutation { ): ProductMediaUpdate @doc(category: "Products") """ - Creates a new product type. - + Creates a new product type. + Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. """ productTypeCreate( @@ -16411,8 +16103,8 @@ type Mutation { ): ProductTypeCreate @doc(category: "Products") """ - Deletes a product type. - + Deletes a product type. + Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. """ productTypeDelete( @@ -16421,8 +16113,8 @@ type Mutation { ): ProductTypeDelete @doc(category: "Products") """ - Deletes product types. - + Deletes product types. + Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. """ productTypeBulkDelete( @@ -16431,8 +16123,8 @@ type Mutation { ): ProductTypeBulkDelete @doc(category: "Products") """ - Updates an existing product type. - + Updates an existing product type. + Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. """ productTypeUpdate( @@ -16444,8 +16136,8 @@ type Mutation { ): ProductTypeUpdate @doc(category: "Products") """ - Reorder the attributes of a product type. - + Reorder the attributes of a product type. + Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. """ productTypeReorderAttributes( @@ -16460,8 +16152,8 @@ type Mutation { ): ProductTypeReorderAttributes @doc(category: "Products") """ - Reorder product attribute values. - + Reorder product attribute values. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productReorderAttributeValues( @@ -16476,8 +16168,8 @@ type Mutation { ): ProductReorderAttributeValues @doc(category: "Products") """ - Create new digital content. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec - + Create new digital content. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec + Requires one of the following permissions: MANAGE_PRODUCTS. """ digitalContentCreate( @@ -16489,8 +16181,8 @@ type Mutation { ): DigitalContentCreate @doc(category: "Products") """ - Remove digital content assigned to given variant. - + Remove digital content assigned to given variant. + Requires one of the following permissions: MANAGE_PRODUCTS. """ digitalContentDelete( @@ -16499,8 +16191,8 @@ type Mutation { ): DigitalContentDelete @doc(category: "Products") """ - Update digital content. - + Updates digital content. + Requires one of the following permissions: MANAGE_PRODUCTS. """ digitalContentUpdate( @@ -16512,8 +16204,8 @@ type Mutation { ): DigitalContentUpdate @doc(category: "Products") """ - Generate new URL to digital content. - + Generate new URL to digital content. + Requires one of the following permissions: MANAGE_PRODUCTS. """ digitalContentUrlCreate( @@ -16522,8 +16214,8 @@ type Mutation { ): DigitalContentUrlCreate @doc(category: "Products") """ - Creates a new variant for a product. - + Creates a new variant for a product. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productVariantCreate( @@ -16532,42 +16224,28 @@ type Mutation { ): ProductVariantCreate @doc(category: "Products") """ - Deletes a product variant. - + Deletes a product variant. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productVariantDelete( - """ - External ID of a product variant to update. - - Added in Saleor 3.10. - """ + """External ID of a product variant to update.""" externalReference: String """ID of a product variant to delete.""" id: ID - """ - SKU of a product variant to delete. - - Added in Saleor 3.8. - """ + """SKU of a product variant to delete.""" sku: String ): ProductVariantDelete @doc(category: "Products") """ - Creates product variants for a given product. - + Creates product variants for a given product. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productVariantBulkCreate( - """ - Policies of error handling. DEFAULT: REJECT_EVERYTHING - - Added in Saleor 3.11. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Policies of error handling. DEFAULT: REJECT_EVERYTHING""" errorPolicy: ErrorPolicyEnum """ID of the product to create the variants for.""" @@ -16578,12 +16256,8 @@ type Mutation { ): ProductVariantBulkCreate @doc(category: "Products") """ - Update multiple product variants. - - Added in Saleor 3.11. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Updates multiple product variants. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productVariantBulkUpdate( @@ -16598,25 +16272,21 @@ type Mutation { ): ProductVariantBulkUpdate @doc(category: "Products") """ - Deletes product variants. - + Deletes product variants. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productVariantBulkDelete( """List of product variant IDs to delete.""" ids: [ID!] - """ - List of product variant SKUs to delete. - - Added in Saleor 3.8. - """ + """List of product variant SKUs to delete.""" skus: [String!] ): ProductVariantBulkDelete @doc(category: "Products") """ - Creates stocks for product variant. - + Creates stocks for product variant. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productVariantStocksCreate( @@ -16628,8 +16298,8 @@ type Mutation { ): ProductVariantStocksCreate @doc(category: "Products") """ - Delete stocks from product variant. - + Deletes stocks from product variant. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productVariantStocksDelete( @@ -16644,8 +16314,8 @@ type Mutation { ): ProductVariantStocksDelete @doc(category: "Products") """ - Update stocks for product variant. - + Updates stocks for product variant. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productVariantStocksUpdate( @@ -16660,16 +16330,12 @@ type Mutation { ): ProductVariantStocksUpdate @doc(category: "Products") """ - Updates an existing variant for product. - + Updates an existing variant for product. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productVariantUpdate( - """ - External ID of a product variant to update. - - Added in Saleor 3.10. - """ + """External ID of a product variant to update.""" externalReference: String """ID of a product to update.""" @@ -16678,17 +16344,13 @@ type Mutation { """Fields required to update a product variant.""" input: ProductVariantInput! - """ - SKU of a product variant to update. - - Added in Saleor 3.8. - """ + """SKU of a product variant to update.""" sku: String ): ProductVariantUpdate @doc(category: "Products") """ - Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook. - + Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productVariantSetDefault( @@ -16700,8 +16362,8 @@ type Mutation { ): ProductVariantSetDefault @doc(category: "Products") """ - Creates/updates translations for a product variant. - + Creates/updates translations for a product variant. + Requires one of the following permissions: MANAGE_TRANSLATIONS. """ productVariantTranslate( @@ -16716,14 +16378,10 @@ type Mutation { ): ProductVariantTranslate @doc(category: "Products") """ - Creates/updates translations for products variants. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Creates/updates translations for product variants. + Requires one of the following permissions: MANAGE_TRANSLATIONS. - + Triggers the following webhook events: - TRANSLATION_CREATED (async): A translation was created. - TRANSLATION_UPDATED (async): A translation was updated. @@ -16732,13 +16390,13 @@ type Mutation { """Policies of error handling. DEFAULT: REJECT_EVERYTHING""" errorPolicy: ErrorPolicyEnum - """List of products variants translations.""" + """List of product variant translations.""" translations: [ProductVariantBulkTranslateInput!]! ): ProductVariantBulkTranslate @doc(category: "Products") @webhookEventsInfo(asyncEvents: [TRANSLATION_CREATED, TRANSLATION_UPDATED], syncEvents: []) """ - Manage product variant prices in channels. - + Manage product variant prices in channels. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productVariantChannelListingUpdate( @@ -16750,17 +16408,13 @@ type Mutation { """ input: [ProductVariantChannelListingAddInput!]! - """ - SKU of a product variant to update. - - Added in Saleor 3.8. - """ + """SKU of a product variant to update.""" sku: String ): ProductVariantChannelListingUpdate @doc(category: "Products") """ - Reorder product variant attribute values. - + Reorder product variant attribute values. + Requires one of the following permissions: MANAGE_PRODUCTS. """ productVariantReorderAttributeValues( @@ -16776,9 +16430,7 @@ type Mutation { """ Deactivates product variant preorder. It changes all preorder allocation into regular allocation. - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_PRODUCTS. """ productVariantPreorderDeactivate( @@ -16787,8 +16439,8 @@ type Mutation { ): ProductVariantPreorderDeactivate @doc(category: "Products") """ - Assign an media to a product variant. - + Assign an media to a product variant. + Requires one of the following permissions: MANAGE_PRODUCTS. """ variantMediaAssign( @@ -16800,8 +16452,8 @@ type Mutation { ): VariantMediaAssign @doc(category: "Products") """ - Unassign an media from a product variant. - + Unassign an media from a product variant. + Requires one of the following permissions: MANAGE_PRODUCTS. """ variantMediaUnassign( @@ -16813,8 +16465,8 @@ type Mutation { ): VariantMediaUnassign @doc(category: "Products") """ - Captures the authorized payment amount. - + Captures the authorized payment amount. + Requires one of the following permissions: MANAGE_ORDERS. """ paymentCapture( @@ -16826,8 +16478,8 @@ type Mutation { ): PaymentCapture @doc(category: "Payments") """ - Refunds the captured payment amount. - + Refunds the captured payment amount. + Requires one of the following permissions: MANAGE_ORDERS. """ paymentRefund( @@ -16839,8 +16491,8 @@ type Mutation { ): PaymentRefund @doc(category: "Payments") """ - Voids the authorized payment. - + Voids the authorized payment. + Requires one of the following permissions: MANAGE_ORDERS. """ paymentVoid( @@ -16867,12 +16519,8 @@ type Mutation { ): PaymentCheckBalance @doc(category: "Payments") """ - Create transaction for checkout or order. - - Added in Saleor 3.4. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Creates transaction for checkout or order. + Requires one of the following permissions: HANDLE_PAYMENTS. """ transactionCreate( @@ -16888,22 +16536,14 @@ type Mutation { """ Update transaction. - - Added in Saleor 3.4. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app. """ transactionUpdate( """The ID of the transaction. One of field id or token is required.""" id: ID - """ - The token of the transaction. One of field id or token is required. - - Added in Saleor 3.14. - """ + """The token of the transaction. One of field id or token is required.""" token: UUID """Input data required to create a new transaction object.""" @@ -16915,11 +16555,7 @@ type Mutation { """ Request an action for payment transaction. - - Added in Saleor 3.4. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: HANDLE_PAYMENTS. """ transactionRequestAction( @@ -16927,7 +16563,7 @@ type Mutation { actionType: TransactionActionEnum! """ - Transaction request amount. If empty for refund or capture, maximal possible amount will be used. + Transaction request amount. If empty, maximal possible amount will be used. """ amount: PositiveDecimal @@ -16935,20 +16571,26 @@ type Mutation { id: ID """ - The token of the transaction. One of field id or token is required. - - Added in Saleor 3.14. + Reason of the refund + + Added in Saleor 3.22. + """ + refundReason: String + + """ + ID of a `Page` (Model) to reference in reason. + + Added in Saleor 3.22. """ + refundReasonReference: ID + + """The token of the transaction. One of field id or token is required.""" token: UUID ): TransactionRequestAction @doc(category: "Payments") """ Request a refund for payment transaction based on granted refund. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: HANDLE_PAYMENTS. """ transactionRequestRefundForGrantedRefund( @@ -16968,16 +16610,21 @@ type Mutation { """ Report the event for the transaction. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app. + + Triggers the following webhook events: + - TRANSACTION_ITEM_METADATA_UPDATED (async): Optionally called when transaction's metadata was updated. + - 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. """ transactionEventReport( - """The amount of the event to report.""" - amount: PositiveDecimal! + """ + The amount of the event to report. + + Required for all `REQUEST`, `SUCCESS`, `ACTION_REQUIRED`, and `ADJUSTMENT` events. For other events, the amount will be calculated based on the previous events with the same pspReference. If not possible to calculate, the mutation will return an error. + """ + amount: PositiveDecimal """List of all possible actions for the transaction""" availableActions: [TransactionActionEnum!] @@ -16990,9 +16637,18 @@ type Mutation { """The ID of the transaction. One of field id or token is required.""" id: ID - """The message related to the event.""" + """ + The message related to the event. The maximum length is 512 characters; any text exceeding this limit will be truncated. + """ message: String + """ + Details of the payment method used for the transaction. + + Added in Saleor 3.22. + """ + paymentMethodDetails: PaymentMethodDetailsInput + """PSP Reference of the event to report.""" pspReference: String! @@ -17001,23 +16657,31 @@ type Mutation { """ time: DateTime + """The token of the transaction. One of field id or token is required.""" + token: UUID + + """ + Fields required to update the transaction metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ - The token of the transaction. One of field id or token is required. - - Added in Saleor 3.14. + transactionMetadata: [MetadataInput!] + """ - token: UUID + Fields required to update the transaction private metadata. + + Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ + transactionPrivateMetadata: [MetadataInput!] """Current status of the event to report.""" type: TransactionEventTypeEnum! - ): TransactionEventReport @doc(category: "Payments") + ): TransactionEventReport @doc(category: "Payments") @webhookEventsInfo(asyncEvents: [TRANSACTION_ITEM_METADATA_UPDATED, CHECKOUT_FULLY_PAID, ORDER_UPDATED], syncEvents: []) """ 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. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ paymentGatewayInitialize( """ @@ -17034,10 +16698,6 @@ type Mutation { """ 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. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ transactionInitialize( """ @@ -17052,8 +16712,6 @@ type Mutation { """ The customer's IP address. If not provided Saleor will try to determine the customer's IP address on its own. The customer's IP address will be passed to the payment app. The IP should be in ipv4 or ipv6 format. The field can be used only by an app that has `HANDLE_PAYMENTS` permission. - - Added in Saleor 3.16. """ customerIpAddress: String @@ -17062,8 +16720,6 @@ type Mutation { """ The idempotency key assigned to the action. It will be passed to the payment app to discover potential duplicate actions. If not provided, the default one will be generated. If empty string provided, INVALID error code will be raised. - - Added in Saleor 3.14. """ idempotencyKey: String @@ -17072,17 +16728,11 @@ type Mutation { ): TransactionInitialize @doc(category: "Payments") """ - Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. + Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. """ transactionProcess( """ The customer's IP address. If not provided Saleor will try to determine the customer's IP address on its own. The customer's IP address will be passed to the payment app. The IP should be in ipv4 or ipv6 format. The field can be used only by an app that has `HANDLE_PAYMENTS` permission. - - Added in Saleor 3.16. """ customerIpAddress: String @@ -17096,21 +16746,15 @@ type Mutation { """ The token of the transaction to process. One of field id or token is required. - - Added in Saleor 3.14. """ token: UUID ): TransactionProcess @doc(category: "Payments") """ Request to delete a stored payment method on payment provider side. - - Added in Saleor 3.16. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + 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. """ @@ -17124,13 +16768,9 @@ type Mutation { """ Initializes payment gateway for tokenizing payment method session. - - Added in Saleor 3.16. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + 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. """ @@ -17147,13 +16787,9 @@ type Mutation { """ Tokenize payment method. - - Added in Saleor 3.16. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + 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. """ @@ -17175,13 +16811,9 @@ type Mutation { """ Tokenize payment method. - - Added in Saleor 3.16. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + 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. """ @@ -17199,8 +16831,8 @@ type Mutation { ): PaymentMethodProcessTokenization @doc(category: "Payments") @webhookEventsInfo(asyncEvents: [], syncEvents: [PAYMENT_METHOD_PROCESS_TOKENIZATION_SESSION]) """ - Creates a new page. - + Creates a new page. + Requires one of the following permissions: MANAGE_PAGES. """ pageCreate( @@ -17209,8 +16841,8 @@ type Mutation { ): PageCreate @doc(category: "Pages") """ - Deletes a page. - + Deletes a page. + Requires one of the following permissions: MANAGE_PAGES. """ pageDelete( @@ -17219,8 +16851,8 @@ type Mutation { ): PageDelete @doc(category: "Pages") """ - Deletes pages. - + Deletes pages. + Requires one of the following permissions: MANAGE_PAGES. """ pageBulkDelete( @@ -17229,8 +16861,8 @@ type Mutation { ): PageBulkDelete @doc(category: "Pages") """ - Publish pages. - + Publish pages. + Requires one of the following permissions: MANAGE_PAGES. """ pageBulkPublish( @@ -17242,8 +16874,8 @@ type Mutation { ): PageBulkPublish @doc(category: "Pages") """ - Updates an existing page. - + Updates an existing page. + Requires one of the following permissions: MANAGE_PAGES. """ pageUpdate( @@ -17255,8 +16887,8 @@ type Mutation { ): PageUpdate @doc(category: "Pages") """ - Creates/updates translations for a page. - + Creates/updates translations for a page. + Requires one of the following permissions: MANAGE_TRANSLATIONS. """ pageTranslate( @@ -17271,8 +16903,8 @@ type Mutation { ): PageTranslate @doc(category: "Pages") """ - Create a new page type. - + Creates a new page type. + Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. """ pageTypeCreate( @@ -17281,8 +16913,8 @@ type Mutation { ): PageTypeCreate @doc(category: "Pages") """ - Update page type. - + Updates page type. + Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. """ pageTypeUpdate( @@ -17294,8 +16926,8 @@ type Mutation { ): PageTypeUpdate @doc(category: "Pages") """ - Delete a page type. - + Deletes a page type. + Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. """ pageTypeDelete( @@ -17304,8 +16936,8 @@ type Mutation { ): PageTypeDelete @doc(category: "Pages") """ - Delete page types. - + Deletes page types. + Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. """ pageTypeBulkDelete( @@ -17314,8 +16946,8 @@ type Mutation { ): PageTypeBulkDelete @doc(category: "Pages") """ - Assign attributes to a given page type. - + Assign attributes to a given page type. + Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. """ pageAttributeAssign( @@ -17327,8 +16959,8 @@ type Mutation { ): PageAttributeAssign @doc(category: "Pages") """ - Unassign attributes from a given page type. - + Unassign attributes from a given page type. + Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. """ pageAttributeUnassign( @@ -17340,8 +16972,8 @@ type Mutation { ): PageAttributeUnassign @doc(category: "Pages") """ - Reorder the attributes of a page type. - + Reorder the attributes of a page type. + Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. """ pageTypeReorderAttributes( @@ -17353,8 +16985,8 @@ type Mutation { ): PageTypeReorderAttributes @doc(category: "Pages") """ - Reorder page attribute values. - + Reorder page attribute values. + Requires one of the following permissions: MANAGE_PAGES. """ pageReorderAttributeValues( @@ -17369,8 +17001,8 @@ type Mutation { ): PageReorderAttributeValues @doc(category: "Pages") """ - Completes creating an order. - + Completes creating an order. + Requires one of the following permissions: MANAGE_ORDERS. """ draftOrderComplete( @@ -17379,8 +17011,8 @@ type Mutation { ): DraftOrderComplete @doc(category: "Orders") """ - Creates a new draft order. - + Creates a new draft order. + Requires one of the following permissions: MANAGE_ORDERS. """ draftOrderCreate( @@ -17389,16 +17021,12 @@ type Mutation { ): DraftOrderCreate @doc(category: "Orders") """ - Deletes a draft order. - + Deletes a draft order. + Requires one of the following permissions: MANAGE_ORDERS. """ draftOrderDelete( - """ - External ID of a product to delete. - - Added in Saleor 3.10. - """ + """External ID of a product to delete.""" externalReference: String """ID of a product to delete.""" @@ -17406,8 +17034,8 @@ type Mutation { ): DraftOrderDelete @doc(category: "Orders") """ - Deletes draft orders. - + Deletes draft orders. + Requires one of the following permissions: MANAGE_ORDERS. """ draftOrderBulkDelete( @@ -17416,26 +17044,22 @@ type Mutation { ): DraftOrderBulkDelete @doc(category: "Orders") """ - Deletes order lines. - + Deletes order lines. + Requires one of the following permissions: MANAGE_ORDERS. """ draftOrderLinesBulkDelete( """List of order lines IDs to delete.""" ids: [ID!]! - ): DraftOrderLinesBulkDelete @doc(category: "Orders") @deprecated(reason: "This field will be removed in Saleor 4.0.") + ): DraftOrderLinesBulkDelete @doc(category: "Orders") @deprecated """ - Updates a draft order. - + Updates a draft order. + Requires one of the following permissions: MANAGE_ORDERS. """ draftOrderUpdate( - """ - External ID of a draft order to update. - - Added in Saleor 3.10. - """ + """External ID of a draft order to update.""" externalReference: String """ID of a draft order to update.""" @@ -17447,9 +17071,7 @@ type Mutation { """ Adds note to the order. - - DEPRECATED: this mutation will be removed in Saleor 4.0. - + Requires one of the following permissions: MANAGE_ORDERS. """ orderAddNote( @@ -17458,11 +17080,11 @@ type Mutation { """Fields required to create a note for the order.""" input: OrderAddNoteInput! - ): OrderAddNote @doc(category: "Orders") @deprecated(reason: "This field will be removed in Saleor 4.0. Use `orderNoteAdd` instead.") + ): OrderAddNote @doc(category: "Orders") @deprecated(reason: "Use `orderNoteAdd` instead.") """ - Cancel an order. - + Cancel an order. + Requires one of the following permissions: MANAGE_ORDERS. """ orderCancel( @@ -17471,8 +17093,8 @@ type Mutation { ): OrderCancel @doc(category: "Orders") """ - Capture an order. - + Capture an order. + Requires one of the following permissions: MANAGE_ORDERS. """ orderCapture( @@ -17484,8 +17106,8 @@ type Mutation { ): OrderCapture @doc(category: "Orders") """ - Confirms an unconfirmed order by changing status to unfulfilled. - + Confirms an unconfirmed order by changing status to unfulfilled. + Requires one of the following permissions: MANAGE_ORDERS. """ orderConfirm( @@ -17494,10 +17116,10 @@ type Mutation { ): OrderConfirm @doc(category: "Orders") """ - Creates new fulfillments for an order. - + Creates new fulfillments for an order. + Requires one of the following permissions: MANAGE_ORDERS. - + Triggers the following webhook events: - FULFILLMENT_CREATED (async): A new fulfillment is created. - ORDER_FULFILLED (async): Order is fulfilled. @@ -17513,8 +17135,8 @@ type Mutation { ): OrderFulfill @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [FULFILLMENT_CREATED, ORDER_FULFILLED, FULFILLMENT_TRACKING_NUMBER_UPDATED, FULFILLMENT_APPROVED], syncEvents: []) """ - Cancels existing fulfillment and optionally restocks items. - + Cancels existing fulfillment and optionally restocks items. + Requires one of the following permissions: MANAGE_ORDERS. """ orderFulfillmentCancel( @@ -17527,11 +17149,9 @@ type Mutation { """ Approve existing fulfillment. - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_ORDERS. - + Triggers the following webhook events: - FULFILLMENT_APPROVED (async): Fulfillment is approved. """ @@ -17547,10 +17167,10 @@ type Mutation { ): FulfillmentApprove @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [FULFILLMENT_APPROVED], syncEvents: []) """ - Updates a fulfillment for an order. - + Updates a fulfillment for an order. + Requires one of the following permissions: MANAGE_ORDERS. - + Triggers the following webhook events: - FULFILLMENT_TRACKING_NUMBER_UPDATED (async): Fulfillment tracking number is updated. """ @@ -17563,8 +17183,8 @@ type Mutation { ): FulfillmentUpdateTracking @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [FULFILLMENT_TRACKING_NUMBER_UPDATED], syncEvents: []) """ - Refund products. - + Refund products. + Requires one of the following permissions: MANAGE_ORDERS. """ orderFulfillmentRefundProducts( @@ -17576,8 +17196,8 @@ type Mutation { ): FulfillmentRefundProducts @doc(category: "Orders") """ - Return products. - + Return products. + Requires one of the following permissions: MANAGE_ORDERS. """ orderFulfillmentReturnProducts( @@ -17590,11 +17210,7 @@ type Mutation { """ Adds granted refund to the order. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_ORDERS. """ orderGrantRefundCreate( @@ -17607,11 +17223,7 @@ type Mutation { """ Updates granted refund. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_ORDERS. """ orderGrantRefundUpdate( @@ -17623,8 +17235,8 @@ type Mutation { ): OrderGrantRefundUpdate @doc(category: "Orders") """ - Create order lines for an order. - + Creates order lines for an order. + Requires one of the following permissions: MANAGE_ORDERS. """ orderLinesCreate( @@ -17636,8 +17248,8 @@ type Mutation { ): OrderLinesCreate @doc(category: "Orders") """ - Deletes an order line from an order. - + Deletes an order line from an order. + Requires one of the following permissions: MANAGE_ORDERS. """ orderLineDelete( @@ -17646,8 +17258,8 @@ type Mutation { ): OrderLineDelete @doc(category: "Orders") """ - Updates an order line of an order. - + Updates an order line of an order. + Requires one of the following permissions: MANAGE_ORDERS. """ orderLineUpdate( @@ -17659,8 +17271,8 @@ type Mutation { ): OrderLineUpdate @doc(category: "Orders") """ - Adds discount to the order. - + Adds discount to the order. + Requires one of the following permissions: MANAGE_ORDERS. """ orderDiscountAdd( @@ -17672,8 +17284,8 @@ type Mutation { ): OrderDiscountAdd @doc(category: "Orders") """ - Update discount for the order. - + Update discount for the order. + Requires one of the following permissions: MANAGE_ORDERS. """ orderDiscountUpdate( @@ -17685,8 +17297,8 @@ type Mutation { ): OrderDiscountUpdate @doc(category: "Orders") """ - Remove discount from the order. - + Remove discount from the order. + Requires one of the following permissions: MANAGE_ORDERS. """ orderDiscountDelete( @@ -17695,8 +17307,8 @@ type Mutation { ): OrderDiscountDelete @doc(category: "Orders") """ - Update discount for the order line. - + Update discount for the order line. + Requires one of the following permissions: MANAGE_ORDERS. """ orderLineDiscountUpdate( @@ -17708,8 +17320,8 @@ type Mutation { ): OrderLineDiscountUpdate @doc(category: "Orders") """ - Remove discount applied to the order line. - + Remove discount applied to the order line. + Requires one of the following permissions: MANAGE_ORDERS. """ orderLineDiscountRemove( @@ -17719,11 +17331,7 @@ type Mutation { """ Adds note to the order. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_ORDERS. """ orderNoteAdd( @@ -17736,11 +17344,7 @@ type Mutation { """ Updates note of an order. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_ORDERS. """ orderNoteUpdate( @@ -17752,8 +17356,8 @@ type Mutation { ): OrderNoteUpdate @doc(category: "Orders") """ - Mark order as manually paid. - + Mark order as manually paid. + Requires one of the following permissions: MANAGE_ORDERS. """ orderMarkAsPaid( @@ -17765,8 +17369,8 @@ type Mutation { ): OrderMarkAsPaid @doc(category: "Orders") """ - Refund an order. - + Refund an order. + Requires one of the following permissions: MANAGE_ORDERS. """ orderRefund( @@ -17778,16 +17382,12 @@ type Mutation { ): OrderRefund @doc(category: "Orders") """ - Updates an order. - + Updates an order. + Requires one of the following permissions: MANAGE_ORDERS. """ orderUpdate( - """ - External ID of an order to update. - - Added in Saleor 3.10. - """ + """External ID of an order to update.""" externalReference: String """ID of an order to update.""" @@ -17798,8 +17398,8 @@ type Mutation { ): OrderUpdate @doc(category: "Orders") """ - Updates a shipping method of the order. Requires shipping method ID to update, when null is passed then currently assigned shipping method is removed. - + Updates a shipping method of the order. Requires shipping method ID to update, when null is passed then currently assigned shipping method is removed. + Requires one of the following permissions: MANAGE_ORDERS. """ orderUpdateShipping( @@ -17811,8 +17411,8 @@ type Mutation { ): OrderUpdateShipping @doc(category: "Orders") """ - Void an order. - + Void an order. + Requires one of the following permissions: MANAGE_ORDERS. """ orderVoid( @@ -17821,8 +17421,8 @@ type Mutation { ): OrderVoid @doc(category: "Orders") """ - Cancels orders. - + Cancels orders. + Requires one of the following permissions: MANAGE_ORDERS. """ orderBulkCancel( @@ -17832,11 +17432,7 @@ type Mutation { """ Creates multiple orders. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_ORDERS_IMPORT. """ orderBulkCreate( @@ -17875,7 +17471,9 @@ type Mutation { ): DeletePrivateMetadata """ - Updates metadata of an object. To use it, you need to have access to the modified object. + Updates metadata of an object.Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ updateMetadata( """ID or token (for Order and Checkout) of an object to update.""" @@ -17886,7 +17484,9 @@ type Mutation { ): UpdateMetadata """ - Updates private metadata of an object. To use it, you need to be an authenticated staff user or an app and have access to the modified object. + Updates private metadata of an object. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ updatePrivateMetadata( """ID or token (for Order and Checkout) of an object to update.""" @@ -17897,8 +17497,8 @@ type Mutation { ): UpdatePrivateMetadata """ - Assigns storefront's navigation menus. - + Assigns storefront's navigation menus. + Requires one of the following permissions: MANAGE_MENUS, MANAGE_SETTINGS. """ assignNavigation( @@ -17910,10 +17510,10 @@ type Mutation { ): AssignNavigation @doc(category: "Menu") """ - Creates a new Menu. - + Creates a new Menu. + Requires one of the following permissions: MANAGE_MENUS. - + Triggers the following webhook events: - MENU_CREATED (async): A menu was created. """ @@ -17923,10 +17523,10 @@ type Mutation { ): MenuCreate @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_CREATED], syncEvents: []) """ - Deletes a menu. - + Deletes a menu. + Requires one of the following permissions: MANAGE_MENUS. - + Triggers the following webhook events: - MENU_DELETED (async): A menu was deleted. """ @@ -17936,10 +17536,10 @@ type Mutation { ): MenuDelete @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_DELETED], syncEvents: []) """ - Deletes menus. - + Deletes menus. + Requires one of the following permissions: MANAGE_MENUS. - + Triggers the following webhook events: - MENU_DELETED (async): A menu was deleted. """ @@ -17949,10 +17549,10 @@ type Mutation { ): MenuBulkDelete @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_DELETED], syncEvents: []) """ - Updates a menu. - + Updates a menu. + Requires one of the following permissions: MANAGE_MENUS. - + Triggers the following webhook events: - MENU_UPDATED (async): A menu was updated. """ @@ -17965,10 +17565,10 @@ type Mutation { ): MenuUpdate @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_UPDATED], syncEvents: []) """ - Creates a new menu item. - + Creates a new menu item. + Requires one of the following permissions: MANAGE_MENUS. - + Triggers the following webhook events: - MENU_ITEM_CREATED (async): A menu item was created. """ @@ -17980,10 +17580,10 @@ type Mutation { ): MenuItemCreate @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_ITEM_CREATED], syncEvents: []) """ - Deletes a menu item. - + Deletes a menu item. + Requires one of the following permissions: MANAGE_MENUS. - + Triggers the following webhook events: - MENU_ITEM_DELETED (async): A menu item was deleted. """ @@ -17993,10 +17593,10 @@ type Mutation { ): MenuItemDelete @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_ITEM_DELETED], syncEvents: []) """ - Deletes menu items. - + Deletes menu items. + Requires one of the following permissions: MANAGE_MENUS. - + Triggers the following webhook events: - MENU_ITEM_DELETED (async): A menu item was deleted. """ @@ -18006,10 +17606,10 @@ type Mutation { ): MenuItemBulkDelete @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_ITEM_DELETED], syncEvents: []) """ - Updates a menu item. - + Updates a menu item. + Requires one of the following permissions: MANAGE_MENUS. - + Triggers the following webhook events: - MENU_ITEM_UPDATED (async): A menu item was updated. """ @@ -18024,8 +17624,8 @@ type Mutation { ): MenuItemUpdate @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_ITEM_UPDATED], syncEvents: []) """ - Creates/updates translations for a menu item. - + Creates/updates translations for a menu item. + Requires one of the following permissions: MANAGE_TRANSLATIONS. """ menuItemTranslate( @@ -18040,10 +17640,10 @@ type Mutation { ): MenuItemTranslate @doc(category: "Menu") """ - Moves items of menus. - + Moves items of menus. + 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. """ @@ -18056,10 +17656,10 @@ type Mutation { ): MenuItemMove @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_ITEM_UPDATED], syncEvents: []) """ - Request an invoice for the order using plugin. - + Request an invoice for the order using plugin. + Requires one of the following permissions: MANAGE_ORDERS. - + Triggers the following webhook events: - INVOICE_REQUESTED (async): An invoice was requested. """ @@ -18072,10 +17672,10 @@ type Mutation { ): InvoiceRequest @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [INVOICE_REQUESTED], syncEvents: []) """ - Requests deletion of an invoice. - + Requests deletion of an invoice. + Requires one of the following permissions: MANAGE_ORDERS. - + Triggers the following webhook events: - INVOICE_DELETED (async): An invoice was requested to delete. """ @@ -18085,8 +17685,8 @@ type Mutation { ): InvoiceRequestDelete @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [INVOICE_DELETED], syncEvents: []) """ - Creates a ready to send invoice. - + Creates a ready to send invoice. + Requires one of the following permissions: MANAGE_ORDERS. """ invoiceCreate( @@ -18098,8 +17698,8 @@ type Mutation { ): InvoiceCreate @doc(category: "Orders") """ - Deletes an invoice. - + Deletes an invoice. + Requires one of the following permissions: MANAGE_ORDERS. """ invoiceDelete( @@ -18108,8 +17708,8 @@ type Mutation { ): InvoiceDelete @doc(category: "Orders") """ - Updates an invoice. - + Updates an invoice. + Requires one of the following permissions: MANAGE_ORDERS. """ invoiceUpdate( @@ -18121,10 +17721,10 @@ type Mutation { ): InvoiceUpdate @doc(category: "Orders") """ - Send an invoice notification to the customer. - + Send an invoice notification to the customer. + Requires one of the following permissions: MANAGE_ORDERS. - + Triggers the following webhook events: - INVOICE_SENT (async): A notification for invoice send - NOTIFY_USER (async): A notification for invoice send @@ -18135,10 +17735,10 @@ type Mutation { ): InvoiceSendNotification @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [INVOICE_SENT, NOTIFY_USER], syncEvents: []) """ - Activate a gift card. - + Activate a gift card. + Requires one of the following permissions: MANAGE_GIFT_CARD. - + Triggers the following webhook events: - GIFT_CARD_STATUS_CHANGED (async): A gift card was activated. """ @@ -18148,10 +17748,10 @@ type Mutation { ): GiftCardActivate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_STATUS_CHANGED], syncEvents: []) """ - Creates a new gift card. - + Creates a new gift card. + Requires one of the following permissions: MANAGE_GIFT_CARD. - + Triggers the following webhook events: - GIFT_CARD_CREATED (async): A gift card was created. - NOTIFY_USER (async): A notification for created gift card. @@ -18162,12 +17762,10 @@ type Mutation { ): GiftCardCreate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_CREATED, NOTIFY_USER], syncEvents: []) """ - Delete gift card. - - Added in Saleor 3.1. - + Deletes gift card. + Requires one of the following permissions: MANAGE_GIFT_CARD. - + Triggers the following webhook events: - GIFT_CARD_DELETED (async): A gift card was deleted. """ @@ -18177,10 +17775,10 @@ type Mutation { ): GiftCardDelete @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_DELETED], syncEvents: []) """ - Deactivate a gift card. - + Deactivate a gift card. + Requires one of the following permissions: MANAGE_GIFT_CARD. - + Triggers the following webhook events: - GIFT_CARD_STATUS_CHANGED (async): A gift card was deactivated. """ @@ -18190,10 +17788,10 @@ type Mutation { ): GiftCardDeactivate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_STATUS_CHANGED], syncEvents: []) """ - Update a gift card. - + Update a gift card. + Requires one of the following permissions: MANAGE_GIFT_CARD. - + Triggers the following webhook events: - GIFT_CARD_UPDATED (async): A gift card was updated. """ @@ -18207,11 +17805,9 @@ type Mutation { """ Resend a gift card. - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_GIFT_CARD. - + Triggers the following webhook events: - NOTIFY_USER (async): A notification for gift card resend. """ @@ -18222,11 +17818,9 @@ type Mutation { """ Adds note to the gift card. - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_GIFT_CARD. - + Triggers the following webhook events: - GIFT_CARD_UPDATED (async): A gift card was updated. """ @@ -18239,12 +17833,10 @@ type Mutation { ): GiftCardAddNote @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_UPDATED], syncEvents: []) """ - Create gift cards. - - Added in Saleor 3.1. - + Creates gift cards. + Requires one of the following permissions: MANAGE_GIFT_CARD. - + Triggers the following webhook events: - GIFT_CARD_CREATED (async): A gift card was created. - NOTIFY_USER (async): A notification for created gift card. @@ -18255,12 +17847,10 @@ type Mutation { ): GiftCardBulkCreate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_CREATED, NOTIFY_USER], syncEvents: []) """ - Delete gift cards. - - Added in Saleor 3.1. - + Deletes gift cards. + Requires one of the following permissions: MANAGE_GIFT_CARD. - + Triggers the following webhook events: - GIFT_CARD_DELETED (async): A gift card was deleted. """ @@ -18271,11 +17861,9 @@ type Mutation { """ Activate gift cards. - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_GIFT_CARD. - + Triggers the following webhook events: - GIFT_CARD_STATUS_CHANGED (async): A gift card was activated. """ @@ -18286,11 +17874,9 @@ type Mutation { """ Deactivate gift cards. - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_GIFT_CARD. - + Triggers the following webhook events: - GIFT_CARD_STATUS_CHANGED (async): A gift card was deactivated. """ @@ -18300,8 +17886,8 @@ type Mutation { ): GiftCardBulkDeactivate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_STATUS_CHANGED], syncEvents: []) """ - Update plugin configuration. - + Update plugin configuration. + Requires one of the following permissions: MANAGE_PLUGINS. """ pluginUpdate( @@ -18317,8 +17903,6 @@ type Mutation { """ Trigger sending a notification with the notify plugin method. Serializes nodes provided as ids parameter and includes this data in the notification payload. - - Added in Saleor 3.1. """ externalNotificationTrigger( """ @@ -18331,17 +17915,13 @@ type Mutation { """The ID of notification plugin.""" pluginId: String - ): ExternalNotificationTrigger @deprecated(reason: "\\n\\nDEPRECATED: this mutation will be removed in Saleor 4.0.") + ): ExternalNotificationTrigger @deprecated """ Creates a new promotion. - - Added in Saleor 3.17. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - PROMOTION_CREATED (async): A promotion was created. - PROMOTION_STARTED (async): Optionally called if promotion was started. @@ -18353,13 +17933,9 @@ type Mutation { """ Updates an existing promotion. - - Added in Saleor 3.17. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - PROMOTION_UPDATED (async): A promotion was updated. - PROMOTION_STARTED (async): Optionally called if promotion was started. @@ -18375,13 +17951,9 @@ type Mutation { """ Deletes a promotion. - - Added in Saleor 3.17. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - PROMOTION_DELETED (async): A promotion was deleted. """ @@ -18392,13 +17964,9 @@ type Mutation { """ Creates a new promotion rule. - - Added in Saleor 3.17. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - PROMOTION_RULE_CREATED (async): A promotion rule was created. """ @@ -18409,13 +17977,9 @@ type Mutation { """ Updates an existing promotion rule. - - Added in Saleor 3.17. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - PROMOTION_RULE_UPDATED (async): A promotion rule was updated. """ @@ -18429,13 +17993,9 @@ type Mutation { """ Deletes a promotion rule. - - Added in Saleor 3.17. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - PROMOTION_RULE_DELETED (async): A promotion rule was deleted. """ @@ -18446,9 +18006,7 @@ type Mutation { """ Creates/updates translations for a promotion. - - Added in Saleor 3.17. - + Requires one of the following permissions: MANAGE_TRANSLATIONS. """ promotionTranslate( @@ -18464,9 +18022,7 @@ type Mutation { """ Creates/updates translations for a promotion rule. - - Added in Saleor 3.17. - + Requires one of the following permissions: MANAGE_TRANSLATIONS. """ promotionRuleTranslate( @@ -18482,13 +18038,9 @@ type Mutation { """ Deletes promotions. - - Added in Saleor 3.17. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - PROMOTION_DELETED (async): A promotion was deleted. """ @@ -18499,39 +18051,35 @@ type Mutation { """ Creates a new sale. - - DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionCreate` mutation instead. - + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - SALE_CREATED (async): A sale was created. """ saleCreate( """Fields required to create a sale.""" input: SaleInput! - ): SaleCreate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_CREATED], syncEvents: []) + ): SaleCreate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_CREATED], syncEvents: []) @deprecated(reason: "Use `promotionCreate` mutation instead.") """ Deletes a sale. - - DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionDelete` mutation instead. - + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - SALE_DELETED (async): A sale was deleted. """ saleDelete( """ID of a sale to delete.""" id: ID! - ): SaleDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_DELETED], syncEvents: []) + ): SaleDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_DELETED], syncEvents: []) @deprecated(reason: "Use `promotionDelete` mutation instead.") """ - Deletes sales. - + Deletes sales. + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - SALE_DELETED (async): A sale was deleted. """ @@ -18542,11 +18090,9 @@ type Mutation { """ Updates a sale. - - DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionUpdate` mutation instead. - + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - SALE_UPDATED (async): A sale was updated. - SALE_TOGGLE (async): Optionally triggered when a sale is started or stopped. @@ -18557,15 +18103,13 @@ type Mutation { """Fields required to update a sale.""" input: SaleInput! - ): SaleUpdate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_UPDATED, SALE_TOGGLE], syncEvents: []) + ): SaleUpdate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_UPDATED, SALE_TOGGLE], syncEvents: []) @deprecated(reason: "Use `promotionUpdate` mutation instead.") """ Adds products, categories, collections to a sale. - - DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionRuleCreate` mutation instead. - + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - SALE_UPDATED (async): A sale was updated. """ @@ -18575,15 +18119,13 @@ type Mutation { """Fields required to modify catalogue IDs of sale.""" input: CatalogueInput! - ): SaleAddCatalogues @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_UPDATED], syncEvents: []) + ): SaleAddCatalogues @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_UPDATED], syncEvents: []) @deprecated(reason: "Use `promotionRuleCreate` and `promotionRuleUpdate` mutations instead.") """ Removes products, categories, collections from a sale. - - DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionRuleUpdate` or `promotionRuleDelete` mutations instead. - + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - SALE_UPDATED (async): A sale was updated. """ @@ -18593,13 +18135,11 @@ type Mutation { """Fields required to modify catalogue IDs of sale.""" input: CatalogueInput! - ): SaleRemoveCatalogues @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_UPDATED], syncEvents: []) + ): SaleRemoveCatalogues @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_UPDATED], syncEvents: []) @deprecated(reason: "Use `promotionRuleUpdate` and `promotionRuleDelete` mutations instead.") """ Creates/updates translations for a sale. - - DEPRECATED: this mutation will be removed in Saleor 4.0. Use `PromotionTranslate` mutation instead. - + Requires one of the following permissions: MANAGE_TRANSLATIONS. """ saleTranslate( @@ -18611,13 +18151,11 @@ type Mutation { """Translation language code.""" languageCode: LanguageCodeEnum! - ): SaleTranslate @doc(category: "Discounts") + ): SaleTranslate @doc(category: "Discounts") @deprecated(reason: "Use `promotionTranslate` mutation instead.") """ Manage sale's availability in channels. - - DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionRuleCreate` or `promotionRuleUpdate` mutations instead. - + Requires one of the following permissions: MANAGE_DISCOUNTS. """ saleChannelListingUpdate( @@ -18626,13 +18164,13 @@ type Mutation { """Fields required to update sale channel listings.""" input: SaleChannelListingInput! - ): SaleChannelListingUpdate @doc(category: "Discounts") + ): SaleChannelListingUpdate @doc(category: "Discounts") @deprecated(reason: "Use `promotionRuleUpdate` mutation instead.") """ - Creates a new voucher. - + Creates a new voucher. + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - VOUCHER_CREATED (async): A voucher was created. - VOUCHER_CODES_CREATED (async): A voucher codes were created. @@ -18643,10 +18181,10 @@ type Mutation { ): VoucherCreate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_CREATED, VOUCHER_CODES_CREATED], syncEvents: []) """ - Deletes a voucher. - + Deletes a voucher. + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - VOUCHER_DELETED (async): A voucher was deleted. """ @@ -18656,10 +18194,10 @@ type Mutation { ): VoucherDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_DELETED], syncEvents: []) """ - Deletes vouchers. - + Deletes vouchers. + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - VOUCHER_DELETED (async): A voucher was deleted. """ @@ -18669,10 +18207,10 @@ type Mutation { ): VoucherBulkDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_DELETED], syncEvents: []) """ - Updates a voucher. - + Updates a voucher. + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - VOUCHER_UPDATED (async): A voucher was updated. - VOUCHER_CODES_CREATED (async): A voucher code was created. @@ -18686,10 +18224,10 @@ type Mutation { ): VoucherUpdate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_UPDATED, VOUCHER_CODES_CREATED], syncEvents: []) """ - Adds products, categories, collections to a voucher. - + Adds products, categories, collections to a voucher. + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - VOUCHER_UPDATED (async): A voucher was updated. """ @@ -18702,10 +18240,10 @@ type Mutation { ): VoucherAddCatalogues @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_UPDATED], syncEvents: []) """ - Removes products, categories, collections from a voucher. - + Removes products, categories, collections from a voucher. + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - VOUCHER_UPDATED (async): A voucher was updated. """ @@ -18718,8 +18256,8 @@ type Mutation { ): VoucherRemoveCatalogues @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_UPDATED], syncEvents: []) """ - Creates/updates translations for a voucher. - + Creates/updates translations for a voucher. + Requires one of the following permissions: MANAGE_TRANSLATIONS. """ voucherTranslate( @@ -18734,10 +18272,10 @@ type Mutation { ): VoucherTranslate @doc(category: "Discounts") """ - Manage voucher's availability in channels. - + Manage voucher's availability in channels. + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - VOUCHER_UPDATED (async): A voucher was updated. """ @@ -18751,11 +18289,11 @@ type Mutation { """ Deletes voucher codes. - - Added in Saleor 3.18. - + + Added in Saleor 3.18. + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - VOUCHER_CODES_DELETED (async): A voucher codes were deleted. """ @@ -18765,10 +18303,10 @@ type Mutation { ): VoucherCodeBulkDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_CODES_DELETED], syncEvents: []) """ - Export products to csv file. - + Export products to csv file. + Requires one of the following permissions: MANAGE_PRODUCTS. - + Triggers the following webhook events: - NOTIFY_USER (async): A notification for the exported file. - PRODUCT_EXPORT_COMPLETED (async): A notification for the exported file. @@ -18780,11 +18318,9 @@ type Mutation { """ Export gift cards to csv file. - - Added in Saleor 3.1. - + Requires one of the following permissions: MANAGE_GIFT_CARD. - + 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. @@ -18796,13 +18332,13 @@ type Mutation { """ Export voucher codes to csv/xlsx file. - + Added in Saleor 3.18. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + Requires one of the following permissions: MANAGE_DISCOUNTS. - + Triggers the following webhook events: - VOUCHER_CODE_EXPORT_COMPLETED (async): A notification for the exported file. """ @@ -18812,8 +18348,8 @@ type Mutation { ): ExportVoucherCodes @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_CODE_EXPORT_COMPLETED], syncEvents: []) """ - 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 - + Upload a file. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec + Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. """ fileUpload( @@ -18823,39 +18359,27 @@ type Mutation { """ Adds a gift card or a voucher to a checkout. - + Triggers the following webhook events: - CHECKOUT_UPDATED (async): A checkout was updated. """ checkoutAddPromoCode( - """ - The ID of the checkout. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - checkoutId: ID + """The ID of the checkout.""" + checkoutId: ID @deprecated(reason: "Use `id` instead.") - """ - The checkout's ID. - - Added in Saleor 3.4. - """ + """The checkout's ID.""" id: ID """Gift card code or voucher code.""" promoCode: String! - """ - Checkout token. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - token: UUID + """Checkout token.""" + token: UUID @deprecated(reason: "Use `id` instead.") ): CheckoutAddPromoCode @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) """ - Update billing address in the existing checkout. - + Updates billing address in the existing checkout. + Triggers the following webhook events: - CHECKOUT_UPDATED (async): A checkout was updated. """ @@ -18863,38 +18387,29 @@ type Mutation { """The billing address of the checkout.""" billingAddress: AddressInput! - """ - The ID of the checkout. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - checkoutId: ID + """The ID of the checkout.""" + checkoutId: ID @deprecated(reason: "Use `id` instead.") - """ - The checkout's ID. - - Added in Saleor 3.4. - """ + """The checkout's ID.""" id: ID """ - Checkout token. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - token: UUID + Indicates whether the billing address should be saved to the user’s address book upon checkout completion. If not provided, the default behavior is to save the address. + Added in Saleor 3.21. """ - The rules for changing validation for received billing address data. - - Added in Saleor 3.5. - """ + saveAddress: Boolean = true + + """Checkout token.""" + token: UUID @deprecated(reason: "Use `id` instead.") + + """The rules for changing validation for received billing address data.""" validationRules: CheckoutAddressValidationRules ): CheckoutBillingAddressUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) """ 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. - + 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. @@ -18908,24 +18423,16 @@ type Mutation { - ORDER_CONFIRMED (async): Optionally triggered when newly created order are automatically marked as confirmed. """ checkoutComplete( - """ - The ID of the checkout. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - checkoutId: ID + """The ID of the checkout.""" + checkoutId: ID @deprecated(reason: "Use `id` instead.") - """ - The checkout's ID. - - Added in Saleor 3.4. - """ + """The checkout's ID.""" id: ID """ - Fields required to update the checkout metadata. - - Added in Saleor 3.8. + Fields required to update the checkout metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] @@ -18937,26 +18444,18 @@ type Mutation { """ redirectUrl: String - """ - Determines whether to store the payment source for future usage. - - DEPRECATED: this field will be removed in Saleor 4.0. Use checkoutPaymentCreate for this action. - """ - storeSource: Boolean = false + """Determines whether to store the payment source for future usage.""" + storeSource: Boolean = false @deprecated(reason: "Use checkoutPaymentCreate for this action.") - """ - Checkout token. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - token: UUID + """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]) """ Create a new checkout. - + `skipValidation` field requires HANDLE_CHECKOUTS and AUTHENTICATED_APP permissions. - + Triggers the following webhook events: - CHECKOUT_CREATED (async): A checkout was created. """ @@ -18965,193 +18464,139 @@ type Mutation { input: CheckoutCreateInput! ): CheckoutCreate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_CREATED], syncEvents: []) - """ - Create new checkout from existing order. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """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") """ - Sets the customer as the owner of the checkout. - + Sets the customer as the owner of the checkout. + Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_USER. - + Triggers the following webhook events: - CHECKOUT_UPDATED (async): A checkout was updated. """ checkoutCustomerAttach( - """ - The ID of the checkout. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - checkoutId: ID + """The ID of the checkout.""" + checkoutId: ID @deprecated(reason: "Use `id` instead.") """ ID of customer to attach to checkout. Requires IMPERSONATE_USER permission when customerId is different than the logged-in user. """ customerId: ID - """ - The checkout's ID. - - Added in Saleor 3.4. - """ + """The checkout's ID.""" id: ID - """ - Checkout token. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - token: UUID + """Checkout token.""" + token: UUID @deprecated(reason: "Use `id` instead.") ): CheckoutCustomerAttach @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) """ - Removes the user assigned as the owner of the checkout. - + Removes the user assigned as the owner of the checkout. + Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_USER. - + Triggers the following webhook events: - CHECKOUT_UPDATED (async): A checkout was updated. """ checkoutCustomerDetach( - """ - The ID of the checkout. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - checkoutId: ID + """The ID of the checkout.""" + checkoutId: ID @deprecated(reason: "Use `id` instead.") - """ - The checkout's ID. - - Added in Saleor 3.4. - """ + """The checkout's ID.""" id: ID - """ - Checkout token. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - token: UUID + """Checkout token.""" + token: UUID @deprecated(reason: "Use `id` instead.") ): CheckoutCustomerDetach @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) + """ + Updates customer note in the existing checkout object. + + Added in Saleor 3.21. + + Triggers the following webhook events: + - CHECKOUT_UPDATED (async): A checkout was updated. + """ + checkoutCustomerNoteUpdate( + """New customer note content.""" + customerNote: String! + + """The checkout's ID.""" + id: ID! + ): CheckoutCustomerNoteUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) + """ Updates email address in the existing checkout object. - + Triggers the following webhook events: - CHECKOUT_UPDATED (async): A checkout was updated. """ checkoutEmailUpdate( - """ - The ID of the checkout. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - checkoutId: ID + """The ID of the checkout.""" + checkoutId: ID @deprecated(reason: "Use `id` instead.") """email.""" email: String! - """ - The checkout's ID. - - Added in Saleor 3.4. - """ + """The checkout's ID.""" id: ID - """ - Checkout token. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - token: UUID + """Checkout token.""" + token: UUID @deprecated(reason: "Use `id` instead.") ): CheckoutEmailUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) """ Deletes a CheckoutLine. - + Triggers the following webhook events: - CHECKOUT_UPDATED (async): A checkout was updated. """ checkoutLineDelete( - """ - The ID of the checkout. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - checkoutId: ID + """The ID of the checkout.""" + checkoutId: ID @deprecated(reason: "Use `id` instead.") - """ - The checkout's ID. - - Added in Saleor 3.4. - """ + """The checkout's ID.""" id: ID """ID of the checkout line to delete.""" lineId: ID - """ - Checkout token. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - token: UUID - ): CheckoutLineDelete @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) @deprecated(reason: "This field will be removed in Saleor 4.0. Use `checkoutLinesDelete` instead.") + """Checkout token.""" + token: UUID @deprecated(reason: "Use `id` instead.") + ): CheckoutLineDelete @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) @deprecated(reason: "Use `checkoutLinesDelete` instead.") """ Deletes checkout lines. - + Triggers the following webhook events: - CHECKOUT_UPDATED (async): A checkout was updated. """ checkoutLinesDelete( - """ - The checkout's ID. - - Added in Saleor 3.4. - """ + """The checkout's ID.""" id: ID """A list of checkout lines.""" linesIds: [ID!]! - """ - Checkout token. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - token: UUID + """Checkout token.""" + token: UUID @deprecated(reason: "Use `id` instead.") ): CheckoutLinesDelete @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) """ Adds a checkout line to the existing checkout.If line was already in checkout, its quantity will be increased. - + Triggers the following webhook events: - CHECKOUT_UPDATED (async): A checkout was updated. """ checkoutLinesAdd( - """ - The ID of the checkout. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - checkoutId: ID + """The ID of the checkout.""" + checkoutId: ID @deprecated(reason: "Use `id` instead.") - """ - The checkout's ID. - - Added in Saleor 3.4. - """ + """The checkout's ID.""" id: ID """ @@ -19159,33 +18604,21 @@ type Mutation { """ lines: [CheckoutLineInput!]! - """ - Checkout token. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - token: UUID + """Checkout token.""" + token: UUID @deprecated(reason: "Use `id` instead.") ): CheckoutLinesAdd @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) """ Updates checkout line in the existing checkout. - + Triggers the following webhook events: - CHECKOUT_UPDATED (async): A checkout was updated. """ checkoutLinesUpdate( - """ - The ID of the checkout. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - checkoutId: ID + """The ID of the checkout.""" + checkoutId: ID @deprecated(reason: "Use `id` instead.") - """ - The checkout's ID. - - Added in Saleor 3.4. - """ + """The checkout's ID.""" id: ID """ @@ -19193,33 +18626,21 @@ type Mutation { """ lines: [CheckoutLineUpdateInput!]! - """ - Checkout token. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - token: UUID + """Checkout token.""" + token: UUID @deprecated(reason: "Use `id` instead.") ): CheckoutLinesUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) """ Remove a gift card or a voucher from a checkout. - + Triggers the following webhook events: - CHECKOUT_UPDATED (async): A checkout was updated. """ checkoutRemovePromoCode( - """ - The ID of the checkout. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - checkoutId: ID + """The ID of the checkout.""" + checkoutId: ID @deprecated(reason: "Use `id` instead.") - """ - The checkout's ID. - - Added in Saleor 3.4. - """ + """The checkout's ID.""" id: ID """Gift card code or voucher code.""" @@ -19228,118 +18649,79 @@ type Mutation { """Gift card or voucher ID.""" promoCodeId: ID - """ - Checkout token. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - token: UUID + """Checkout token.""" + token: UUID @deprecated(reason: "Use `id` instead.") ): CheckoutRemovePromoCode @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) - """Create a new payment for given checkout.""" + """Creates a new payment for given checkout.""" checkoutPaymentCreate( - """ - The ID of the checkout. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - checkoutId: ID + """The ID of the checkout.""" + checkoutId: ID @deprecated(reason: "Use `id` instead.") - """ - The checkout's ID. - - Added in Saleor 3.4. - """ + """The checkout's ID.""" id: ID """Data required to create a new payment.""" input: PaymentInput! - """ - Checkout token. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - token: UUID + """Checkout token.""" + token: UUID @deprecated(reason: "Use `id` instead.") ): CheckoutPaymentCreate @doc(category: "Checkout") """ - Update shipping address in the existing checkout. - + Updates shipping address in the existing checkout. + Triggers the following webhook events: - CHECKOUT_UPDATED (async): A checkout was updated. """ checkoutShippingAddressUpdate( - """ - The ID of the checkout. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - checkoutId: ID + """The ID of the checkout.""" + checkoutId: ID @deprecated(reason: "Use `id` instead.") + + """The checkout's ID.""" + id: ID """ - The checkout's ID. - - Added in Saleor 3.4. + Indicates whether the shipping address should be saved to the user’s address book upon checkout completion. If not provided, the default behavior is to save the address. + + Added in Saleor 3.21. """ - id: ID + saveAddress: Boolean = true """The mailing address to where the checkout will be shipped.""" shippingAddress: AddressInput! - """ - Checkout token. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - token: UUID + """Checkout token.""" + token: UUID @deprecated(reason: "Use `id` instead.") - """ - The rules for changing validation for received shipping address data. - - Added in Saleor 3.5. - """ + """The rules for changing validation for received shipping address data.""" validationRules: CheckoutAddressValidationRules ): CheckoutShippingAddressUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) """ Updates the shipping method of the checkout. - + 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. """ checkoutShippingMethodUpdate( - """ - The ID of the checkout. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - checkoutId: ID + """The ID of the checkout.""" + checkoutId: ID @deprecated(reason: "Use `id` instead.") - """ - The checkout's ID. - - Added in Saleor 3.4. - """ + """The checkout's ID.""" id: ID """Shipping method.""" shippingMethodId: ID - """ - Checkout token. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - token: UUID - ): CheckoutShippingMethodUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT]) @deprecated(reason: "This field will be removed in Saleor 4.0. Use `checkoutDeliveryMethodUpdate` instead.") + """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.") """ - 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. - - Added in Saleor 3.1. - + 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. + 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. @@ -19348,58 +18730,36 @@ type Mutation { """Delivery Method ID (`Warehouse` ID or `ShippingMethod` ID).""" deliveryMethodId: ID - """ - The checkout's ID. - - Added in Saleor 3.4. - """ + """The checkout's ID.""" id: ID - """ - Checkout token. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - token: UUID + """Checkout token.""" + token: UUID @deprecated(reason: "Use `id` instead.") ): CheckoutDeliveryMethodUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT]) """ - Update language code in the existing checkout. - + Updates language code in the existing checkout. + Triggers the following webhook events: - CHECKOUT_UPDATED (async): A checkout was updated. """ checkoutLanguageCodeUpdate( - """ - The ID of the checkout. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - checkoutId: ID + """The ID of the checkout.""" + checkoutId: ID @deprecated(reason: "Use `id` instead.") - """ - The checkout's ID. - - Added in Saleor 3.4. - """ + """The checkout's ID.""" id: ID """New language code.""" languageCode: LanguageCodeEnum! - """ - Checkout token. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `id` instead. - """ - token: UUID + """Checkout token.""" + token: UUID @deprecated(reason: "Use `id` instead.") ): CheckoutLanguageCodeUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) """ Create new order from existing checkout. Requires the following permissions: AUTHENTICATED_APP and HANDLE_CHECKOUTS. - - Added in Saleor 3.2. - + 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. @@ -19417,16 +18777,16 @@ type Mutation { id: ID! """ - Fields required to update the checkout metadata. - - Added in Saleor 3.8. + Fields required to update the checkout metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Fields required to update the checkout private metadata. - - Added in Saleor 3.8. + Fields required to update the checkout private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] @@ -19437,10 +18797,10 @@ type Mutation { ): 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]) """ - Creates new channel. - + Creates a new channel. + Requires one of the following permissions: MANAGE_CHANNELS. - + Triggers the following webhook events: - CHANNEL_CREATED (async): A channel was created. """ @@ -19451,12 +18811,12 @@ type Mutation { """ Update a channel. - + Requires one of the following permissions: MANAGE_CHANNELS. Requires one of the following permissions when updating only `orderSettings` field: `MANAGE_CHANNELS`, `MANAGE_ORDERS`. Requires one of the following permissions when updating only `checkoutSettings` field: `MANAGE_CHANNELS`, `MANAGE_CHECKOUTS`. Requires one of the following permissions when updating only `paymentSettings` field: `MANAGE_CHANNELS`, `HANDLE_PAYMENTS`. - + 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. @@ -19470,10 +18830,10 @@ type Mutation { ): ChannelUpdate @doc(category: "Channels") @webhookEventsInfo(asyncEvents: [CHANNEL_UPDATED, CHANNEL_METADATA_UPDATED], syncEvents: []) """ - Delete a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. - + Deletes a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. + Requires one of the following permissions: MANAGE_CHANNELS. - + Triggers the following webhook events: - CHANNEL_DELETED (async): A channel was deleted. """ @@ -19486,10 +18846,10 @@ type Mutation { ): ChannelDelete @doc(category: "Channels") @webhookEventsInfo(asyncEvents: [CHANNEL_DELETED], syncEvents: []) """ - Activate a channel. - + Activate a channel. + Requires one of the following permissions: MANAGE_CHANNELS. - + Triggers the following webhook events: - CHANNEL_STATUS_CHANGED (async): A channel was activated. """ @@ -19499,10 +18859,10 @@ type Mutation { ): ChannelActivate @doc(category: "Channels") @webhookEventsInfo(asyncEvents: [CHANNEL_STATUS_CHANGED], syncEvents: []) """ - Deactivate a channel. - + Deactivate a channel. + Requires one of the following permissions: MANAGE_CHANNELS. - + Triggers the following webhook events: - CHANNEL_STATUS_CHANGED (async): A channel was deactivated. """ @@ -19513,9 +18873,7 @@ type Mutation { """ Reorder the warehouses of a channel. - - Added in Saleor 3.7. - + Requires one of the following permissions: MANAGE_CHANNELS. """ channelReorderWarehouses( @@ -19528,7 +18886,7 @@ type Mutation { """ Creates an attribute. - + Triggers the following webhook events: - ATTRIBUTE_CREATED (async): An attribute was created. """ @@ -19538,19 +18896,15 @@ type Mutation { ): AttributeCreate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_CREATED], syncEvents: []) """ - Deletes an attribute. - + Deletes an attribute. + Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. - + Triggers the following webhook events: - ATTRIBUTE_DELETED (async): An attribute was deleted. """ attributeDelete( - """ - External ID of an attribute to delete. - - Added in Saleor 3.10. - """ + """External ID of an attribute to delete.""" externalReference: String """ID of an attribute to delete.""" @@ -19558,19 +18912,15 @@ type Mutation { ): AttributeDelete @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_DELETED], syncEvents: []) """ - Updates attribute. - + Updates attribute. + Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. - + Triggers the following webhook events: - ATTRIBUTE_UPDATED (async): An attribute was updated. """ attributeUpdate( - """ - External ID of an attribute to update. - - Added in Saleor 3.10. - """ + """External ID of an attribute to update.""" externalReference: String """ID of an attribute to update.""" @@ -19582,11 +18932,7 @@ type Mutation { """ Creates attributes. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Triggers the following webhook events: - ATTRIBUTE_CREATED (async): An attribute was created. """ @@ -19600,11 +18946,7 @@ type Mutation { """ Updates attributes. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Triggers the following webhook events: - ATTRIBUTE_UPDATED (async): An attribute was updated. Optionally called when new attribute value was created or deleted. - ATTRIBUTE_VALUE_CREATED (async): Called optionally when an attribute value was created. @@ -19619,8 +18961,8 @@ type Mutation { ): AttributeBulkUpdate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_UPDATED, ATTRIBUTE_VALUE_CREATED, ATTRIBUTE_VALUE_DELETED], syncEvents: []) """ - Creates/updates translations for an attribute. - + Creates/updates translations for an attribute. + Requires one of the following permissions: MANAGE_TRANSLATIONS. """ attributeTranslate( @@ -19636,11 +18978,7 @@ type Mutation { """ Creates/updates translations for attributes. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_TRANSLATIONS. """ attributeBulkTranslate( @@ -19652,10 +18990,10 @@ type Mutation { ): AttributeBulkTranslate @doc(category: "Attributes") """ - Deletes attributes. - + Deletes attributes. + Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. - + Triggers the following webhook events: - ATTRIBUTE_DELETED (async): An attribute was deleted. """ @@ -19665,10 +19003,10 @@ type Mutation { ): AttributeBulkDelete @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_DELETED], syncEvents: []) """ - Deletes values of attributes. - + Deletes values of attributes. + Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. - + Triggers the following webhook events: - ATTRIBUTE_VALUE_DELETED (async): An attribute value was deleted. - ATTRIBUTE_UPDATED (async): An attribute was updated. @@ -19679,10 +19017,10 @@ type Mutation { ): AttributeValueBulkDelete @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_DELETED, ATTRIBUTE_UPDATED], syncEvents: []) """ - Creates a value for an attribute. - + Creates a value for an attribute. + Requires one of the following permissions: MANAGE_PRODUCTS. - + Triggers the following webhook events: - ATTRIBUTE_VALUE_CREATED (async): An attribute value was created. - ATTRIBUTE_UPDATED (async): An attribute was updated. @@ -19696,20 +19034,16 @@ type Mutation { ): AttributeValueCreate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_CREATED, ATTRIBUTE_UPDATED], syncEvents: []) """ - Deletes a value of an attribute. - + Deletes a value of an attribute. + Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. - + Triggers the following webhook events: - ATTRIBUTE_VALUE_DELETED (async): An attribute value was deleted. - ATTRIBUTE_UPDATED (async): An attribute was updated. """ attributeValueDelete( - """ - External ID of a value to delete. - - Added in Saleor 3.10. - """ + """External ID of a value to delete.""" externalReference: String """ID of a value to delete.""" @@ -19717,20 +19051,16 @@ type Mutation { ): AttributeValueDelete @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_DELETED, ATTRIBUTE_UPDATED], syncEvents: []) """ - Updates value of an attribute. - + Updates value of an attribute. + Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. - + Triggers the following webhook events: - ATTRIBUTE_VALUE_UPDATED (async): An attribute value was updated. - ATTRIBUTE_UPDATED (async): An attribute was updated. """ attributeValueUpdate( - """ - External ID of an AttributeValue to update. - - Added in Saleor 3.10. - """ + """External ID of an AttributeValue to update.""" externalReference: String """ID of an AttributeValue to update.""" @@ -19741,12 +19071,8 @@ type Mutation { ): AttributeValueUpdate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_UPDATED, ATTRIBUTE_UPDATED], syncEvents: []) """ - Creates/updates translations for attributes values. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Creates/updates translations for attribute values. + Requires one of the following permissions: MANAGE_TRANSLATIONS. """ attributeValueBulkTranslate( @@ -19758,8 +19084,8 @@ type Mutation { ): AttributeValueBulkTranslate @doc(category: "Attributes") """ - Creates/updates translations for an attribute value. - + Creates/updates translations for an attribute value. + Requires one of the following permissions: MANAGE_TRANSLATIONS. """ attributeValueTranslate( @@ -19774,10 +19100,10 @@ type Mutation { ): AttributeValueTranslate @doc(category: "Attributes") """ - Reorder the values of an attribute. - + Reorder the values of an attribute. + Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. - + Triggers the following webhook events: - ATTRIBUTE_VALUE_UPDATED (async): An attribute value was updated. - ATTRIBUTE_UPDATED (async): An attribute was updated. @@ -19792,7 +19118,7 @@ type Mutation { """ Creates a new app. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS. - + Triggers the following webhook events: - APP_INSTALLED (async): An app was installed. """ @@ -19802,10 +19128,10 @@ type Mutation { ): AppCreate @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_INSTALLED], syncEvents: []) """ - Updates an existing app. - + Updates an existing app. + Requires one of the following permissions: MANAGE_APPS. - + Triggers the following webhook events: - APP_UPDATED (async): An app was updated. """ @@ -19818,10 +19144,10 @@ type Mutation { ): AppUpdate @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_UPDATED], syncEvents: []) """ - Deletes an app. - + Deletes an app. + Requires one of the following permissions: MANAGE_APPS. - + Triggers the following webhook events: - APP_DELETED (async): An app was deleted. """ @@ -19831,8 +19157,8 @@ type Mutation { ): AppDelete @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_DELETED], syncEvents: []) """ - Creates a new token. - + Creates a new token. + Requires one of the following permissions: MANAGE_APPS. """ appTokenCreate( @@ -19841,8 +19167,8 @@ type Mutation { ): AppTokenCreate @doc(category: "Apps") """ - Deletes an authentication token assigned to app. - + Deletes an authentication token assigned to app. + Requires one of the following permissions: MANAGE_APPS. """ appTokenDelete( @@ -19865,10 +19191,10 @@ type Mutation { ): AppInstall @doc(category: "Apps") """ - Retry failed installation of new app. - + Retry failed installation of new app. + Requires one of the following permissions: MANAGE_APPS. - + Triggers the following webhook events: - APP_INSTALLED (async): An app was installed. """ @@ -19881,8 +19207,8 @@ type Mutation { ): AppRetryInstall @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_INSTALLED], syncEvents: []) """ - Delete failed installation. - + Deletes failed installation. + Requires one of the following permissions: MANAGE_APPS. """ appDeleteFailedInstallation( @@ -19891,8 +19217,8 @@ type Mutation { ): AppDeleteFailedInstallation @doc(category: "Apps") """ - Fetch and validate manifest. - + Fetch and validate manifest. + Requires one of the following permissions: MANAGE_APPS. """ appFetchManifest( @@ -19901,10 +19227,10 @@ type Mutation { ): AppFetchManifest @doc(category: "Apps") """ - Activate the app. - + Activate the app. + Requires one of the following permissions: MANAGE_APPS. - + Triggers the following webhook events: - APP_STATUS_CHANGED (async): An app was activated. """ @@ -19914,10 +19240,10 @@ type Mutation { ): AppActivate @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_STATUS_CHANGED], syncEvents: []) """ - Deactivate the app. - + Deactivate the app. + Requires one of the following permissions: MANAGE_APPS. - + Triggers the following webhook events: - APP_STATUS_CHANGED (async): An app was deactivated. """ @@ -19926,12 +19252,22 @@ type Mutation { id: ID! ): AppDeactivate @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_STATUS_CHANGED], syncEvents: []) + """ + 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. + + Requires one of the following permissions: MANAGE_APPS. + """ + appReenableSyncWebhooks( + """The app ID to re-enable sync webhooks for.""" + appId: ID! + ): AppReenableSyncWebhooks @doc(category: "Apps") + """Create JWT token.""" tokenCreate( """ The audience that will be included to JWT tokens with prefix `custom:`. - - Added in Saleor 3.8. """ audience: String @@ -19962,8 +19298,8 @@ type Mutation { ): VerifyToken @doc(category: "Authentication") """ - Deactivate all JWT tokens of the currently authenticated user. - + Deactivate all JWT tokens of the currently authenticated user. + Requires one of the following permissions: AUTHENTICATED_USER. """ tokensDeactivateAll: DeactivateAllUserTokens @doc(category: "Authentication") @@ -20015,7 +19351,7 @@ type Mutation { """ Sends an email with the account password modification link. - + Triggers the following webhook events: - NOTIFY_USER (async): A notification for password reset. - ACCOUNT_SET_PASSWORD_REQUESTED (async): Setting a new password for the account is requested. @@ -20023,7 +19359,7 @@ type Mutation { """ requestPasswordReset( """ - Slug of a channel which will be used for notify user. Optional when only one channel exists. + 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 @@ -20038,13 +19374,9 @@ type Mutation { """ Sends a notification confirmation. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: AUTHENTICATED_USER. - + 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. @@ -20059,7 +19391,7 @@ type Mutation { """ Confirm user account with token sent by email during registration. - + Triggers the following webhook events: - ACCOUNT_CONFIRMED (async): Account was confirmed. """ @@ -20086,8 +19418,8 @@ type Mutation { ): SetPassword @doc(category: "Users") """ - Change the password of the logged in user. - + Change the password of the logged in user. + Requires one of the following permissions: AUTHENTICATED_USER. """ passwordChange( @@ -20099,10 +19431,10 @@ type Mutation { ): PasswordChange @doc(category: "Users") """ - Request email change of the logged in user. - + Request email change of the logged in user. + Requires one of the following permissions: AUTHENTICATED_USER. - + 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. @@ -20126,10 +19458,10 @@ type Mutation { ): RequestEmailChange @doc(category: "Users") @webhookEventsInfo(asyncEvents: [NOTIFY_USER, ACCOUNT_CHANGE_EMAIL_REQUESTED], syncEvents: []) """ - Confirm the email change of the logged-in user. - + Confirm the email change of the logged-in user. + Requires one of the following permissions: AUTHENTICATED_USER. - + Triggers the following webhook events: - CUSTOMER_UPDATED (async): A customer account was updated. - NOTIFY_USER (async): A notification that account email change was confirmed. @@ -20147,9 +19479,9 @@ type Mutation { """ Create a new address for the customer. - + Requires one of following set of permissions: AUTHENTICATED_USER or AUTHENTICATED_APP + IMPERSONATE_USER. - + Triggers the following webhook events: - CUSTOMER_UPDATED (async): A customer account was updated. - ADDRESS_CREATED (async): An address was created. @@ -20157,7 +19489,7 @@ type Mutation { accountAddressCreate( """ ID of customer the application is impersonating. The field can be used and is required by apps only. Requires IMPERSONATE_USER and AUTHENTICATED_APP permission. - + Added in Saleor 3.19. """ customerId: ID @@ -20173,7 +19505,7 @@ type Mutation { """ Updates an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER. - + Triggers the following webhook events: - ADDRESS_UPDATED (async): An address was updated. """ @@ -20186,8 +19518,8 @@ type Mutation { ): AccountAddressUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_UPDATED], syncEvents: []) """ - Delete an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER. - + Deletes an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER. + Triggers the following webhook events: - ADDRESS_DELETED (async): An address was deleted. """ @@ -20197,10 +19529,10 @@ type Mutation { ): AccountAddressDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_DELETED], syncEvents: []) """ - Sets a default address for the authenticated user. - + Sets a default address for the authenticated user. + Requires one of the following permissions: AUTHENTICATED_USER. - + Triggers the following webhook events: - CUSTOMER_UPDATED (async): A customer's address was updated. """ @@ -20214,7 +19546,7 @@ type Mutation { """ Register a new user. - + Triggers the following webhook events: - CUSTOMER_CREATED (async): A new customer account was created. - NOTIFY_USER (async): A notification for account confirmation. @@ -20227,9 +19559,9 @@ type Mutation { """ Updates the account of the logged-in user. - + Requires one of following set of permissions: AUTHENTICATED_USER or AUTHENTICATED_APP + IMPERSONATE_USER. - + 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. @@ -20237,7 +19569,7 @@ type Mutation { accountUpdate( """ ID of customer the application is impersonating. The field can be used and is required by apps only. Requires IMPERSONATE_USER and AUTHENTICATED_APP permission. - + Added in Saleor 3.19. """ customerId: ID @@ -20247,10 +19579,10 @@ type Mutation { ): AccountUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED, CUSTOMER_METADATA_UPDATED], syncEvents: []) """ - Sends an email with the account removal link for the logged-in user. - + Sends an email with the account removal link for the logged-in user. + Requires one of the following permissions: AUTHENTICATED_USER. - + Triggers the following webhook events: - NOTIFY_USER (async): A notification for account delete request. - ACCOUNT_DELETE_REQUESTED (async): An account delete requested. @@ -20268,10 +19600,10 @@ type Mutation { ): AccountRequestDeletion @doc(category: "Users") @webhookEventsInfo(asyncEvents: [NOTIFY_USER, ACCOUNT_DELETE_REQUESTED], syncEvents: []) """ - Remove user account. - + Remove user account. + Requires one of the following permissions: AUTHENTICATED_USER. - + Triggers the following webhook events: - ACCOUNT_DELETED (async): Account was deleted. """ @@ -20283,10 +19615,10 @@ type Mutation { ): AccountDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ACCOUNT_DELETED], syncEvents: []) """ - Creates user address. - + Creates user address. + Requires one of the following permissions: MANAGE_USERS. - + Triggers the following webhook events: - ADDRESS_CREATED (async): A new address was created. """ @@ -20299,10 +19631,10 @@ type Mutation { ): AddressCreate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_CREATED], syncEvents: []) """ - Updates an address. - + Updates an address. + Requires one of the following permissions: MANAGE_USERS. - + Triggers the following webhook events: - ADDRESS_UPDATED (async): An address was updated. """ @@ -20315,10 +19647,10 @@ type Mutation { ): AddressUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_UPDATED], syncEvents: []) """ - Deletes an address. - + Deletes an address. + Requires one of the following permissions: MANAGE_USERS. - + Triggers the following webhook events: - ADDRESS_DELETED (async): An address was deleted. """ @@ -20328,10 +19660,10 @@ type Mutation { ): AddressDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_DELETED], syncEvents: []) """ - Sets a default address for the given user. - + Sets a default address for the given user. + Requires one of the following permissions: MANAGE_USERS. - + Triggers the following webhook events: - CUSTOMER_UPDATED (async): A customer was updated. """ @@ -20347,10 +19679,10 @@ type Mutation { ): AddressSetDefault @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED], syncEvents: []) """ - Creates a new customer. - + Creates a new customer. + Requires one of the following permissions: MANAGE_USERS. - + Triggers the following webhook events: - CUSTOMER_CREATED (async): A new customer account was created. - CUSTOMER_METADATA_UPDATED (async): Optionally called when customer's metadata was updated. @@ -20363,20 +19695,16 @@ type Mutation { ): CustomerCreate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_CREATED, CUSTOMER_METADATA_UPDATED, NOTIFY_USER, ACCOUNT_SET_PASSWORD_REQUESTED], syncEvents: []) """ - Updates an existing customer. - + Updates an existing customer. + Requires one of the following permissions: MANAGE_USERS. - + 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. """ customerUpdate( - """ - External ID of a customer to update. - - Added in Saleor 3.10. - """ + """External ID of a customer to update.""" externalReference: String """ID of a customer to update.""" @@ -20387,19 +19715,15 @@ type Mutation { ): CustomerUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED, CUSTOMER_METADATA_UPDATED], syncEvents: []) """ - Deletes a customer. - + Deletes a customer. + Requires one of the following permissions: MANAGE_USERS. - + Triggers the following webhook events: - CUSTOMER_DELETED (async): A customer account was deleted. """ customerDelete( - """ - External ID of a customer to update. - - Added in Saleor 3.10. - """ + """External ID of a customer to update.""" externalReference: String """ID of a customer to delete.""" @@ -20407,10 +19731,10 @@ type Mutation { ): CustomerDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_DELETED], syncEvents: []) """ - Deletes customers. - + Deletes customers. + Requires one of the following permissions: MANAGE_USERS. - + Triggers the following webhook events: - CUSTOMER_DELETED (async): A customer account was deleted. """ @@ -20421,13 +19745,9 @@ type Mutation { """ Updates customers. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - + Requires one of the following permissions: MANAGE_USERS. - + 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. @@ -20441,10 +19761,10 @@ type Mutation { ): CustomerBulkUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED, CUSTOMER_METADATA_UPDATED], syncEvents: []) """ - Creates a new staff user. Apps are not allowed to perform this mutation. - + Creates a new staff user. Apps are not allowed to perform this mutation. + Requires one of the following permissions: MANAGE_STAFF. - + Triggers the following webhook events: - STAFF_CREATED (async): A new staff account was created. - NOTIFY_USER (async): A notification for setting the password. @@ -20456,10 +19776,10 @@ type Mutation { ): StaffCreate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [STAFF_CREATED, NOTIFY_USER, STAFF_SET_PASSWORD_REQUESTED], syncEvents: []) """ - Updates an existing staff user. Apps are not allowed to perform this mutation. - + Updates an existing staff user. Apps are not allowed to perform this mutation. + Requires one of the following permissions: MANAGE_STAFF. - + Triggers the following webhook events: - STAFF_UPDATED (async): A staff account was updated. """ @@ -20472,10 +19792,10 @@ type Mutation { ): StaffUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [STAFF_UPDATED], syncEvents: []) """ - Deletes a staff user. Apps are not allowed to perform this mutation. - + Deletes a staff user. Apps are not allowed to perform this mutation. + Requires one of the following permissions: MANAGE_STAFF. - + Triggers the following webhook events: - STAFF_DELETED (async): A staff account was deleted. """ @@ -20485,10 +19805,10 @@ type Mutation { ): StaffDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [STAFF_DELETED], syncEvents: []) """ - Deletes staff users. Apps are not allowed to perform this mutation. - + Deletes staff users. Apps are not allowed to perform this mutation. + Requires one of the following permissions: MANAGE_STAFF. - + Triggers the following webhook events: - STAFF_DELETED (async): A staff account was deleted. """ @@ -20498,8 +19818,8 @@ type Mutation { ): StaffBulkDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [STAFF_DELETED], syncEvents: []) """ - 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 - + Create a user avatar. Only for staff members. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec + Requires one of the following permissions: AUTHENTICATED_STAFF_USER. """ userAvatarUpdate( @@ -20508,15 +19828,15 @@ type Mutation { ): UserAvatarUpdate @doc(category: "Users") """ - Deletes a user avatar. Only for staff members. - + Deletes a user avatar. Only for staff members. + Requires one of the following permissions: AUTHENTICATED_STAFF_USER. """ userAvatarDelete: UserAvatarDelete @doc(category: "Users") """ - Activate or deactivate users. - + Activate or deactivate users. + Requires one of the following permissions: MANAGE_USERS. """ userBulkSetActive( @@ -20528,10 +19848,10 @@ type Mutation { ): UserBulkSetActive @doc(category: "Users") """ - Create new permission group. Apps are not allowed to perform this mutation. - + Create new permission group. Apps are not allowed to perform this mutation. + Requires one of the following permissions: MANAGE_STAFF. - + Triggers the following webhook events: - PERMISSION_GROUP_CREATED (async) """ @@ -20541,10 +19861,10 @@ type Mutation { ): PermissionGroupCreate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [PERMISSION_GROUP_CREATED], syncEvents: []) """ - Update permission group. Apps are not allowed to perform this mutation. - + Update permission group. Apps are not allowed to perform this mutation. + Requires one of the following permissions: MANAGE_STAFF. - + Triggers the following webhook events: - PERMISSION_GROUP_UPDATED (async) """ @@ -20557,10 +19877,10 @@ type Mutation { ): PermissionGroupUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [PERMISSION_GROUP_UPDATED], syncEvents: []) """ - Delete permission group. Apps are not allowed to perform this mutation. - + Delete permission group. Apps are not allowed to perform this mutation. + Requires one of the following permissions: MANAGE_STAFF. - + Triggers the following webhook events: - PERMISSION_GROUP_DELETED (async) """ @@ -20571,12 +19891,12 @@ type Mutation { } """ -Creates a new webhook subscription. +Creates a new webhook subscription. Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP. """ type WebhookCreate @doc(category: "Webhooks") { - webhookErrors: [WebhookError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + webhookErrors: [WebhookError!]! @deprecated(reason: "Use `errors` field instead.") errors: [WebhookError!]! webhook: Webhook } @@ -20594,7 +19914,6 @@ type WebhookError @doc(category: "Webhooks") { code: WebhookErrorCode! } -"""An enumeration.""" enum WebhookErrorCode @doc(category: "Webhooks") { GRAPHQL_ERROR INVALID @@ -20617,12 +19936,8 @@ input WebhookCreateInput @doc(category: "Webhooks") { """The url to receive the payload.""" targetUrl: String - """ - The events that webhook wants to subscribe. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `asyncEvents` or `syncEvents` instead. - """ - events: [WebhookEventTypeEnum!] + """The events that webhook wants to subscribe.""" + events: [WebhookEventTypeEnum!] @deprecated(reason: "Use `asyncEvents` or `syncEvents` instead.") """The asynchronous events that webhook wants to subscribe.""" asyncEvents: [WebhookEventTypeAsyncEnum!] @@ -20636,48 +19951,36 @@ 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. - - DEPRECATED: this field will be removed in Saleor 4.0. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS. - """ - secretKey: String + """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.") - """ - Subscription query used to define a webhook payload. - - Added in Saleor 3.2. - """ + """Subscription query used to define a webhook payload.""" query: String """ Custom headers, which will be added to HTTP request. There is a limitation of 5 headers per webhook and 998 characters per header.Only `X-*`, `Authorization*`, and `BrokerProperties` keys are allowed. - - Added in Saleor 3.12. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ customHeaders: JSONString } """ -Delete a webhook. Before the deletion, the webhook is deactivated to pause any deliveries that are already scheduled. The deletion might fail if delivery is in progress. In such a case, the webhook is not deleted but remains deactivated. +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. Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP. """ type WebhookDelete @doc(category: "Webhooks") { - webhookErrors: [WebhookError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + webhookErrors: [WebhookError!]! @deprecated(reason: "Use `errors` field instead.") errors: [WebhookError!]! webhook: Webhook } """ -Updates a webhook subscription. +Updates a webhook subscription. Requires one of the following permissions: MANAGE_APPS, AUTHENTICATED_APP. """ type WebhookUpdate @doc(category: "Webhooks") { - webhookErrors: [WebhookError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + webhookErrors: [WebhookError!]! @deprecated(reason: "Use `errors` field instead.") errors: [WebhookError!]! webhook: Webhook } @@ -20689,12 +19992,8 @@ input WebhookUpdateInput @doc(category: "Webhooks") { """The url to receive the payload.""" targetUrl: String - """ - The events that webhook wants to subscribe. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `asyncEvents` or `syncEvents` instead. - """ - events: [WebhookEventTypeEnum!] + """The events that webhook wants to subscribe.""" + events: [WebhookEventTypeEnum!] @deprecated(reason: "Use `asyncEvents` or `syncEvents` instead.") """The asynchronous events that webhook wants to subscribe.""" asyncEvents: [WebhookEventTypeAsyncEnum!] @@ -20708,32 +20007,20 @@ 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. - - DEPRECATED: this field will be removed in Saleor 4.0. As of Saleor 3.5, webhook payloads default to signing using a verifiable JWS. - """ - secretKey: String + """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.") - """ - Subscription query used to define a webhook payload. - - Added in Saleor 3.2. - """ + """Subscription query used to define a webhook payload.""" query: String """ Custom headers, which will be added to HTTP request. There is a limitation of 5 headers per webhook and 998 characters per header.Only `X-*`, `Authorization*`, and `BrokerProperties` keys are allowed. - - Added in Saleor 3.12. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ customHeaders: JSONString } """ -Retries event delivery. +Retries event delivery. Requires one of the following permissions: MANAGE_APPS. """ @@ -20746,10 +20033,6 @@ type EventDeliveryRetry @doc(category: "Webhooks") { """ Performs a dry run of a webhook event. Supports a single event (the first, if multiple provided in the `query`). Requires permission relevant to processed event. -Added in Saleor 3.11. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: AUTHENTICATED_STAFF_USER. """ type WebhookDryRun @doc(category: "Webhooks") { @@ -20771,7 +20054,6 @@ type WebhookDryRunError @doc(category: "Webhooks") { code: WebhookDryRunErrorCode! } -"""An enumeration.""" enum WebhookDryRunErrorCode @doc(category: "Webhooks") { GRAPHQL_ERROR NOT_FOUND @@ -20787,10 +20069,6 @@ enum WebhookDryRunErrorCode @doc(category: "Webhooks") { """ Trigger a webhook event. Supports a single event (the first, if multiple provided in the `webhook.subscription_query`). Requires permission relevant to processed event. Successfully delivered webhook returns `delivery` with status='PENDING' and empty payload. -Added in Saleor 3.11. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: AUTHENTICATED_STAFF_USER. """ type WebhookTrigger @doc(category: "Webhooks") { @@ -20811,7 +20089,6 @@ type WebhookTriggerError @doc(category: "Webhooks") { code: WebhookTriggerErrorCode! } -"""An enumeration.""" enum WebhookTriggerErrorCode @doc(category: "Webhooks") { GRAPHQL_ERROR NOT_FOUND @@ -20826,12 +20103,12 @@ enum WebhookTriggerErrorCode @doc(category: "Webhooks") { } """ -Creates new warehouse. +Creates a new warehouse. Requires one of the following permissions: MANAGE_PRODUCTS. """ type WarehouseCreate @doc(category: "Products") { - warehouseErrors: [WarehouseError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + warehouseErrors: [WarehouseError!]! @deprecated(reason: "Use `errors` field instead.") errors: [WarehouseError!]! warehouse: Warehouse } @@ -20852,7 +20129,6 @@ type WarehouseError @doc(category: "Products") { shippingZones: [ID!] } -"""An enumeration.""" enum WarehouseErrorCode @doc(category: "Products") { ALREADY_EXISTS GRAPHQL_ERROR @@ -20869,11 +20145,7 @@ input WarehouseCreateInput @doc(category: "Products") { """The email address of the warehouse.""" email: String - """ - External ID of the warehouse. - - Added in Saleor 3.10. - """ + """External ID of the warehouse.""" externalReference: String """Warehouse name.""" @@ -20882,21 +20154,17 @@ input WarehouseCreateInput @doc(category: "Products") { """Address of the warehouse.""" address: AddressInput! - """ - Shipping zones supported by the warehouse. - - DEPRECATED: this field will be removed in Saleor 4.0. Providing the zone ids will raise a ValidationError. - """ - shippingZones: [ID!] + """Shipping zones supported by the warehouse.""" + shippingZones: [ID!] @deprecated(reason: "Providing the zone ids will raise a ValidationError.") } """ -Updates given warehouse. +Updates given warehouse. Requires one of the following permissions: MANAGE_PRODUCTS. """ type WarehouseUpdate @doc(category: "Products") { - warehouseErrors: [WarehouseError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + warehouseErrors: [WarehouseError!]! @deprecated(reason: "Use `errors` field instead.") errors: [WarehouseError!]! warehouse: Warehouse } @@ -20908,11 +20176,7 @@ input WarehouseUpdateInput @doc(category: "Products") { """The email address of the warehouse.""" email: String - """ - External ID of the warehouse. - - Added in Saleor 3.10. - """ + """External ID of the warehouse.""" externalReference: String """Warehouse name.""" @@ -20921,58 +20185,48 @@ input WarehouseUpdateInput @doc(category: "Products") { """Address of the warehouse.""" address: AddressInput - """ - Click and collect options: local, all or disabled. - - Added in Saleor 3.1. - """ + """Click and collect options: local, all or disabled.""" clickAndCollectOption: WarehouseClickAndCollectOptionEnum - """ - Visibility of warehouse stocks. - - Added in Saleor 3.1. - """ + """Visibility of warehouse stocks.""" isPrivate: Boolean } """ -Deletes selected warehouse. +Deletes selected warehouse. Requires one of the following permissions: MANAGE_PRODUCTS. """ type WarehouseDelete @doc(category: "Products") { - warehouseErrors: [WarehouseError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + warehouseErrors: [WarehouseError!]! @deprecated(reason: "Use `errors` field instead.") errors: [WarehouseError!]! warehouse: Warehouse } """ -Add shipping zone to given warehouse. +Add shipping zone to given warehouse. Requires one of the following permissions: MANAGE_PRODUCTS. """ type WarehouseShippingZoneAssign @doc(category: "Products") { - warehouseErrors: [WarehouseError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + warehouseErrors: [WarehouseError!]! @deprecated(reason: "Use `errors` field instead.") errors: [WarehouseError!]! warehouse: Warehouse } """ -Remove shipping zone from given warehouse. +Remove shipping zone from given warehouse. Requires one of the following permissions: MANAGE_PRODUCTS. """ type WarehouseShippingZoneUnassign @doc(category: "Products") { - warehouseErrors: [WarehouseError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + warehouseErrors: [WarehouseError!]! @deprecated(reason: "Use `errors` field instead.") errors: [WarehouseError!]! warehouse: Warehouse } """ -Create a tax class. - -Added in Saleor 3.9. +Creates a tax class. Requires one of the following permissions: MANAGE_TAXES. """ @@ -20997,7 +20251,6 @@ type TaxClassCreateError @doc(category: "Taxes") { countryCodes: [String!]! } -"""An enumeration.""" enum TaxClassCreateErrorCode @doc(category: "Taxes") { GRAPHQL_ERROR INVALID @@ -21023,9 +20276,7 @@ input CountryRateInput @doc(category: "Taxes") { } """ -Delete a tax class. After deleting the tax class any products, product types or shipping methods using it are updated to use the default tax class. - -Added in Saleor 3.9. +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. Requires one of the following permissions: MANAGE_TAXES. """ @@ -21047,7 +20298,6 @@ type TaxClassDeleteError @doc(category: "Taxes") { code: TaxClassDeleteErrorCode! } -"""An enumeration.""" enum TaxClassDeleteErrorCode @doc(category: "Taxes") { GRAPHQL_ERROR INVALID @@ -21055,9 +20305,7 @@ enum TaxClassDeleteErrorCode @doc(category: "Taxes") { } """ -Update a tax class. - -Added in Saleor 3.9. +Updates a tax class. Requires one of the following permissions: MANAGE_TAXES. """ @@ -21082,7 +20330,6 @@ type TaxClassUpdateError @doc(category: "Taxes") { countryCodes: [String!]! } -"""An enumeration.""" enum TaxClassUpdateErrorCode @doc(category: "Taxes") { DUPLICATED_INPUT_ITEM GRAPHQL_ERROR @@ -21116,9 +20363,7 @@ input CountryRateUpdateInput @doc(category: "Taxes") { } """ -Update tax configuration for a channel. - -Added in Saleor 3.9. +Updates tax configuration for a channel. Requires one of the following permissions: MANAGE_TAXES. """ @@ -21143,7 +20388,6 @@ type TaxConfigurationUpdateError @doc(category: "Taxes") { countryCodes: [String!]! } -"""An enumeration.""" enum TaxConfigurationUpdateErrorCode @doc(category: "Taxes") { DUPLICATED_INPUT_ITEM GRAPHQL_ERROR @@ -21174,9 +20418,16 @@ input TaxConfigurationUpdateInput @doc(category: "Taxes") { """List of country codes for which to remove the tax configuration.""" removeCountriesConfiguration: [CountryCode!] + """ + 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. Default value is `False`.Can be used only with `taxCalculationStrategy` set to `FLAT_RATES`. + + Added in Saleor 3.21. + """ + useWeightedTaxForShipping: Boolean + """ 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. It's possible to set plugin by using prefix `plugin:` with `PLUGIN_ID` e.g. with Avalara `plugin:mirumee.taxes.avalara`.Will become mandatory in 4.0 for `TAX_APP` `taxCalculationStrategy`. - + Added in Saleor 3.19. """ taxAppId: String @@ -21201,16 +20452,21 @@ input TaxConfigurationPerCountryInput @doc(category: "Taxes") { """ 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. """ taxAppId: String + + """ + 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. Default value is `False`.Can be used only with `taxCalculationStrategy` set to `FLAT_RATES`. + + Added in Saleor 3.21. + """ + useWeightedTaxForShipping: Boolean } """ -Update tax class rates for a specific country. - -Added in Saleor 3.9. +Updates tax class rates for a specific country. Requires one of the following permissions: MANAGE_TAXES. """ @@ -21236,7 +20492,6 @@ type TaxCountryConfigurationUpdateError @doc(category: "Taxes") { taxClassIds: [String!]! } -"""An enumeration.""" enum TaxCountryConfigurationUpdateErrorCode @doc(category: "Taxes") { GRAPHQL_ERROR INVALID @@ -21256,8 +20511,6 @@ input TaxClassRateInput @doc(category: "Taxes") { """ Remove all tax class rates for a specific country. -Added in Saleor 3.9. - Requires one of the following permissions: MANAGE_TAXES. """ type TaxCountryConfigurationDelete @doc(category: "Taxes") { @@ -21279,7 +20532,6 @@ type TaxCountryConfigurationDeleteError @doc(category: "Taxes") { code: TaxCountryConfigurationDeleteErrorCode! } -"""An enumeration.""" enum TaxCountryConfigurationDeleteErrorCode @doc(category: "Taxes") { GRAPHQL_ERROR INVALID @@ -21289,8 +20541,6 @@ enum TaxCountryConfigurationDeleteErrorCode @doc(category: "Taxes") { """ Exempt checkout or order from charging the taxes. When tax exemption is enabled, taxes won't be charged for the checkout or order. Taxes may still be calculated in cases when product prices are entered with the tax included and the net price needs to be known. -Added in Saleor 3.8. - Requires one of the following permissions: MANAGE_TAXES. """ type TaxExemptionManage @doc(category: "Taxes") { @@ -21313,7 +20563,6 @@ type TaxExemptionManageError @doc(category: "Taxes") { code: TaxExemptionManageErrorCode! } -"""An enumeration.""" enum TaxExemptionManageErrorCode @doc(category: "Taxes") { GRAPHQL_ERROR INVALID @@ -21324,10 +20573,6 @@ enum TaxExemptionManageErrorCode @doc(category: "Taxes") { """ 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. -Added in Saleor 3.13. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: MANAGE_PRODUCTS. Triggers the following webhook events: @@ -21363,7 +20608,6 @@ type StockBulkUpdateError @doc(category: "Products") { code: StockBulkUpdateErrorCode! } -"""An enumeration.""" enum StockBulkUpdateErrorCode @doc(category: "Products") { GRAPHQL_ERROR INVALID @@ -21402,12 +20646,12 @@ input StockBulkUpdateInput @doc(category: "Products") { } """ -Creates a new staff notification recipient. +Creates a new staff notification recipient. Requires one of the following permissions: MANAGE_SETTINGS. """ type StaffNotificationRecipientCreate @doc(category: "Users") { - shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + shopErrors: [ShopError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ShopError!]! staffNotificationRecipient: StaffNotificationRecipient } @@ -21425,7 +20669,6 @@ type ShopError @doc(category: "Shop") { code: ShopErrorCode! } -"""An enumeration.""" enum ShopErrorCode { ALREADY_EXISTS CANNOT_FETCH_TAX_RATES @@ -21448,23 +20691,23 @@ input StaffNotificationRecipientInput { } """ -Updates a staff notification recipient. +Updates a staff notification recipient. Requires one of the following permissions: MANAGE_SETTINGS. """ type StaffNotificationRecipientUpdate @doc(category: "Users") { - shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + shopErrors: [ShopError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ShopError!]! staffNotificationRecipient: StaffNotificationRecipient } """ -Delete staff notification recipient. +Deletes staff notification recipient. Requires one of the following permissions: MANAGE_SETTINGS. """ type StaffNotificationRecipientDelete @doc(category: "Users") { - shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + shopErrors: [ShopError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ShopError!]! staffNotificationRecipient: StaffNotificationRecipient } @@ -21472,14 +20715,12 @@ type StaffNotificationRecipientDelete @doc(category: "Users") { """ Updates site domain of the shop. -DEPRECATED: this mutation will be removed in Saleor 4.0. Use `PUBLIC_URL` environment variable instead. - Requires one of the following permissions: MANAGE_SETTINGS. """ type ShopDomainUpdate @doc(category: "Shop") { """Updated shop.""" shop: Shop - shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + shopErrors: [ShopError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ShopError!]! } @@ -21492,7 +20733,7 @@ input SiteDomainInput { } """ -Updates shop settings. +Updates shop settings. Requires one of the following permissions: MANAGE_SETTINGS. @@ -21502,7 +20743,7 @@ Triggers the following webhook events: type ShopSettingsUpdate @doc(category: "Shop") @webhookEventsInfo(asyncEvents: [SHOP_METADATA_UPDATED], syncEvents: []) { """Updated shop.""" shop: Shop - shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + shopErrors: [ShopError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ShopError!]! } @@ -21524,18 +20765,10 @@ input ShopSettingsInput { """Enable automatic fulfillment for all digital products.""" automaticFulfillmentDigitalProducts: Boolean - """ - Enable automatic approval of all new fulfillments. - - Added in Saleor 3.1. - """ + """Enable automatic approval of all new fulfillments.""" fulfillmentAutoApprove: Boolean - """ - Enable ability to approve fulfillments which are unpaid. - - Added in Saleor 3.1. - """ + """Enable ability to approve fulfillments which are unpaid.""" fulfillmentAllowUnpaid: Boolean """Default number of max downloads per digital content URL.""" @@ -21555,96 +20788,77 @@ input ShopSettingsInput { """ Default number of minutes stock will be reserved for anonymous checkout. Enter 0 or null to disable. - - Added in Saleor 3.1. """ reserveStockDurationAnonymousUser: Int """ Default number of minutes stock will be reserved for authenticated checkout. Enter 0 or null to disable. - - Added in Saleor 3.1. """ reserveStockDurationAuthenticatedUser: Int """ Default number of maximum line quantity in single checkout. Minimum possible value is 1, default value is 50. - - Added in Saleor 3.1. """ limitQuantityPerCheckout: Int - """ - Enable automatic account confirmation by email. - - Added in Saleor 3.14. - """ + """Enable automatic account confirmation by email.""" enableAccountConfirmationByEmail: Boolean - """ - Enable possibility to login without account confirmation. - - Added in Saleor 3.15. - """ + """Enable possibility to login without account confirmation.""" allowLoginWithoutConfirmation: Boolean """ - Shop public metadata. - - Added in Saleor 3.15. + Shop public metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Shop private metadata. - - Added in Saleor 3.15. + Shop private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] - """ - Include taxes in prices. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `taxConfigurationUpdate` mutation to configure this setting per channel or country. - """ - includeTaxesInPrices: Boolean + """Include taxes in prices.""" + includeTaxesInPrices: 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 in Saleor 4.0. Use `taxConfigurationUpdate` mutation to configure this setting per channel or country. - """ - displayGrossPrices: Boolean + """Display prices with tax in store.""" + displayGrossPrices: Boolean @deprecated(reason: "Use `taxConfigurationUpdate` mutation to configure this setting per channel or country.") + + """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 in Saleor 4.0. To enable taxes for a shipping method, assign a tax class to the shipping method with `shippingPriceCreate` or `shippingPriceUpdate` mutations. + 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. """ - chargeTaxesOnShipping: Boolean + useLegacyUpdateWebhookEmission: Boolean @deprecated } """ -Fetch tax rates. +Fetch tax rates. Requires one of the following permissions: MANAGE_SETTINGS. """ type ShopFetchTaxRates @doc(category: "Shop") { """Updated shop.""" shop: Shop - shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + shopErrors: [ShopError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ShopError!]! } """ -Creates/updates translations for shop settings. +Creates/updates translations for shop settings. Requires one of the following permissions: MANAGE_TRANSLATIONS. """ type ShopSettingsTranslate @doc(category: "Shop") { """Updated shop settings.""" shop: Shop - translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.") errors: [TranslationError!]! } @@ -21661,12 +20875,12 @@ type TranslationError { code: TranslationErrorCode! } -"""An enumeration.""" enum TranslationErrorCode { GRAPHQL_ERROR INVALID NOT_FOUND REQUIRED + UNIQUE } input ShopSettingsTranslationInput { @@ -21675,26 +20889,26 @@ input ShopSettingsTranslationInput { } """ -Update the shop's address. If the `null` value is passed, the currently selected address will be deleted. +Update the shop's address. If the `null` value is passed, the currently selected address will be deleted. Requires one of the following permissions: MANAGE_SETTINGS. """ type ShopAddressUpdate @doc(category: "Shop") { """Updated shop.""" shop: Shop - shopErrors: [ShopError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + shopErrors: [ShopError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ShopError!]! } """ -Update shop order settings across all channels. Returns `orderSettings` for the first `channel` in alphabetical order. +Update shop order settings across all channels. Returns `orderSettings` for the first `channel` in alphabetical order. Requires one of the following permissions: MANAGE_ORDERS. """ type OrderSettingsUpdate @doc(category: "Orders") { """Order settings.""" orderSettings: OrderSettings - orderSettingsErrors: [OrderSettingsError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderSettingsErrors: [OrderSettingsError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderSettingsError!]! } @@ -21711,7 +20925,6 @@ type OrderSettingsError @doc(category: "Orders") { code: OrderSettingsErrorCode! } -"""An enumeration.""" enum OrderSettingsErrorCode @doc(category: "Orders") { INVALID } @@ -21729,7 +20942,7 @@ input OrderSettingsUpdateInput @doc(category: "Orders") { } """ -Update gift card settings. +Update gift card settings. Requires one of the following permissions: MANAGE_GIFT_CARD. """ @@ -21752,7 +20965,6 @@ type GiftCardSettingsError @doc(category: "Gift cards") { code: GiftCardSettingsErrorCode! } -"""An enumeration.""" enum GiftCardSettingsErrorCode @doc(category: "Gift cards") { INVALID REQUIRED @@ -21776,14 +20988,83 @@ input TimePeriodInputType { } """ -Manage shipping method's availability in channels. +Update refund settings across all channels. + +Added in Saleor 3.22. + +Requires one of the following permissions: MANAGE_SETTINGS. +""" +type RefundSettingsUpdate @doc(category: "Shop") { + """Refund settings.""" + refundSettings: RefundSettings! + refundSettingsErrors: [RefundSettingsUpdateError!]! @deprecated(reason: "Use `errors` field instead.") + errors: [RefundSettingsUpdateError!]! +} + +type RefundSettingsUpdateError @doc(category: "Shop") { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """The error message.""" + message: String + + """Failed to update Refund Settings""" + code: RefundSettingsErrorCode! +} + +enum RefundSettingsErrorCode @doc(category: "Shop") { + INVALID + REQUIRED + GRAPHQL_ERROR +} + +input RefundSettingsUpdateInput @doc(category: "Shop") { + """ + 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. + + Added in Saleor 3.22. + """ + refundReasonReferenceType: ID! +} + +""" +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. + +Added in Saleor 3.22. + +Requires one of the following permissions: MANAGE_SETTINGS. +""" +type RefundReasonReferenceTypeClear @doc(category: "Orders") { + """Refund settings.""" + refundSettings: RefundSettings! + refundSettingsErrors: [RefundReasonReferenceTypeClearError!]! @deprecated(reason: "Use `errors` field instead.") + errors: [RefundReasonReferenceTypeClearError!]! +} + +type RefundReasonReferenceTypeClearError @doc(category: "Shop") { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """The error message.""" + message: String + + """Failed to clear refund reason reference type""" + code: RefundSettingsErrorCode! +} + +""" +Manage shipping method's availability in channels. Requires one of the following permissions: MANAGE_SHIPPING. """ type ShippingMethodChannelListingUpdate @doc(category: "Shipping") { """An updated shipping method instance.""" shippingMethod: ShippingMethodType - shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ShippingError!]! } @@ -21806,7 +21087,6 @@ type ShippingError @doc(category: "Shipping") { channels: [ID!] } -"""An enumeration.""" enum ShippingErrorCode @doc(category: "Shipping") { ALREADY_EXISTS GRAPHQL_ERROR @@ -21841,7 +21121,7 @@ input ShippingMethodChannelListingAddInput @doc(category: "Shipping") { } """ -Creates a new shipping price. +Creates a new shipping price. Requires one of the following permissions: MANAGE_SHIPPING. """ @@ -21849,7 +21129,7 @@ type ShippingPriceCreate @doc(category: "Shipping") { """A shipping zone to which the shipping method belongs.""" shippingZone: ShippingZone shippingMethod: ShippingMethodType - shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ShippingError!]! } @@ -21904,7 +21184,7 @@ input ShippingPostalCodeRulesCreateInputRange @doc(category: "Shipping") { } """ -Deletes a shipping price. +Deletes a shipping price. Requires one of the following permissions: MANAGE_SHIPPING. """ @@ -21914,24 +21194,24 @@ type ShippingPriceDelete @doc(category: "Shipping") { """A shipping zone to which the shipping method belongs.""" shippingZone: ShippingZone - shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ShippingError!]! } """ -Deletes shipping prices. +Deletes shipping prices. Requires one of the following permissions: MANAGE_SHIPPING. """ type ShippingPriceBulkDelete @doc(category: "Shipping") { """Returns how many objects were affected.""" count: Int! - shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ShippingError!]! } """ -Updates a new shipping price. +Updates a new shipping price. Requires one of the following permissions: MANAGE_SHIPPING. """ @@ -21939,17 +21219,17 @@ type ShippingPriceUpdate @doc(category: "Shipping") { """A shipping zone to which the shipping method belongs.""" shippingZone: ShippingZone shippingMethod: ShippingMethodType - shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ShippingError!]! } """ -Creates/updates translations for a shipping method. +Creates/updates translations for a shipping method. Requires one of the following permissions: MANAGE_TRANSLATIONS. """ type ShippingPriceTranslate @doc(category: "Shipping") { - translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.") errors: [TranslationError!]! shippingMethod: ShippingMethodType } @@ -21959,21 +21239,21 @@ input ShippingPriceTranslationInput { """ Translated shipping method description. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString } """ -Exclude products from shipping price. +Exclude products from shipping price. Requires one of the following permissions: MANAGE_SHIPPING. """ type ShippingPriceExcludeProducts @doc(category: "Shipping") { """A shipping method with new list of excluded products.""" shippingMethod: ShippingMethodType - shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ShippingError!]! } @@ -21983,24 +21263,24 @@ input ShippingPriceExcludeProductsInput @doc(category: "Shipping") { } """ -Remove product from excluded list for shipping price. +Remove product from excluded list for shipping price. Requires one of the following permissions: MANAGE_SHIPPING. """ type ShippingPriceRemoveProductFromExclude @doc(category: "Shipping") { """A shipping method with new list of excluded products.""" shippingMethod: ShippingMethodType - shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ShippingError!]! } """ -Creates a new shipping zone. +Creates a new shipping zone. Requires one of the following permissions: MANAGE_SHIPPING. """ type ShippingZoneCreate @doc(category: "Shipping") { - shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ShippingError!]! shippingZone: ShippingZone } @@ -22028,35 +21308,35 @@ input ShippingZoneCreateInput @doc(category: "Shipping") { } """ -Deletes a shipping zone. +Deletes a shipping zone. Requires one of the following permissions: MANAGE_SHIPPING. """ type ShippingZoneDelete @doc(category: "Shipping") { - shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ShippingError!]! shippingZone: ShippingZone } """ -Deletes shipping zones. +Deletes shipping zones. Requires one of the following permissions: MANAGE_SHIPPING. """ type ShippingZoneBulkDelete @doc(category: "Shipping") { """Returns how many objects were affected.""" count: Int! - shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ShippingError!]! } """ -Updates a new shipping zone. +Updates a new shipping zone. Requires one of the following permissions: MANAGE_SHIPPING. """ type ShippingZoneUpdate @doc(category: "Shipping") { - shippingErrors: [ShippingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + shippingErrors: [ShippingError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ShippingError!]! shippingZone: ShippingZone } @@ -22090,14 +21370,14 @@ input ShippingZoneUpdateInput @doc(category: "Shipping") { } """ -Assign attributes to a given product type. +Assign attributes to a given product type. Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. """ type ProductAttributeAssign @doc(category: "Products") { """The updated product type.""" productType: ProductType - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } @@ -22120,7 +21400,6 @@ type ProductError @doc(category: "Products") { values: [ID!] } -"""An enumeration.""" enum ProductErrorCode @doc(category: "Products") { ALREADY_EXISTS ATTRIBUTE_ALREADY_ASSIGNED @@ -22142,6 +21421,8 @@ 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") { @@ -22153,8 +21434,6 @@ input ProductAttributeAssignInput @doc(category: "Products") { """ Whether attribute is allowed in variant selection. Allowed types are: ['dropdown', 'boolean', 'swatch', 'numeric']. - - Added in Saleor 3.1. """ variantSelection: Boolean } @@ -22167,14 +21446,12 @@ enum ProductAttributeType @doc(category: "Products") { """ Update attributes assigned to product variant for given product type. -Added in Saleor 3.1. - Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. """ type ProductAttributeAssignmentUpdate @doc(category: "Products") { """The updated product type.""" productType: ProductType - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } @@ -22184,31 +21461,29 @@ input ProductAttributeAssignmentUpdateInput @doc(category: "Products") { """ Whether attribute is allowed in variant selection. Allowed types are: ['dropdown', 'boolean', 'swatch', 'numeric']. - - Added in Saleor 3.1. """ variantSelection: Boolean! } """ -Un-assign attributes from a given product type. +Un-assign attributes from a given product type. Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. """ type ProductAttributeUnassign @doc(category: "Products") { """The updated product type.""" productType: ProductType - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } """ -Creates a new category. +Creates a new category. Requires one of the following permissions: MANAGE_PRODUCTS. """ type CategoryCreate @doc(category: "Products") { - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! category: Category } @@ -22216,7 +21491,7 @@ type CategoryCreate @doc(category: "Products") { input CategoryInput @doc(category: "Products") { """ Category description. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString @@ -22237,16 +21512,16 @@ input CategoryInput @doc(category: "Products") { backgroundImageAlt: String """ - Fields required to update the category metadata. - - Added in Saleor 3.8. + Fields required to update the category metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Fields required to update the category private metadata. - - Added in Saleor 3.8. + Fields required to update the category private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] } @@ -22265,72 +21540,73 @@ Variables of this type must be set to null in mutations. They will be replaced w scalar Upload """ -Deletes a category. +Deletes a category. Requires one of the following permissions: MANAGE_PRODUCTS. """ type CategoryDelete @doc(category: "Products") { - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! category: Category } """ -Deletes categories. +Deletes categories. Requires one of the following permissions: MANAGE_PRODUCTS. """ type CategoryBulkDelete @doc(category: "Products") { """Returns how many objects were affected.""" count: Int! - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } """ -Updates a category. +Updates a category. Requires one of the following permissions: MANAGE_PRODUCTS. """ type CategoryUpdate @doc(category: "Products") { - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! category: Category } """ -Creates/updates translations for a category. +Creates/updates translations for a category. Requires one of the following permissions: MANAGE_TRANSLATIONS. """ type CategoryTranslate @doc(category: "Products") { - translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.") errors: [TranslationError!]! category: Category } input TranslationInput { + slug: String seoTitle: String seoDescription: String name: String """ Translated description. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString } """ -Adds products to a collection. +Adds products to a collection. Requires one of the following permissions: MANAGE_PRODUCTS. """ type CollectionAddProducts @doc(category: "Products") { """Collection to which products will be added.""" collection: Collection - collectionErrors: [CollectionError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + collectionErrors: [CollectionError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CollectionError!]! } @@ -22350,7 +21626,6 @@ type CollectionError @doc(category: "Products") { code: CollectionErrorCode! } -"""An enumeration.""" enum CollectionErrorCode @doc(category: "Products") { DUPLICATED_INPUT_ITEM GRAPHQL_ERROR @@ -22362,12 +21637,12 @@ enum CollectionErrorCode @doc(category: "Products") { } """ -Creates a new collection. +Creates a new collection. Requires one of the following permissions: MANAGE_PRODUCTS. """ type CollectionCreate @doc(category: "Products") { - collectionErrors: [CollectionError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + collectionErrors: [CollectionError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CollectionError!]! collection: Collection } @@ -22384,7 +21659,7 @@ input CollectionCreateInput @doc(category: "Products") { """ Description of the collection. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString @@ -22398,24 +21673,20 @@ input CollectionCreateInput @doc(category: "Products") { """Search engine optimization fields.""" seo: SeoInput - """ - Publication date. ISO 8601 standard. - - DEPRECATED: this field will be removed in Saleor 4.0. - """ - publicationDate: Date + """Publication date. ISO 8601 standard.""" + publicationDate: Date @deprecated """ - Fields required to update the collection metadata. - - Added in Saleor 3.8. + Fields required to update the collection metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Fields required to update the collection private metadata. - - Added in Saleor 3.8. + Fields required to update the collection private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] @@ -22424,25 +21695,25 @@ input CollectionCreateInput @doc(category: "Products") { } """ -Deletes a collection. +Deletes a collection. Requires one of the following permissions: MANAGE_PRODUCTS. """ type CollectionDelete @doc(category: "Products") { - collectionErrors: [CollectionError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + collectionErrors: [CollectionError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CollectionError!]! collection: Collection } """ -Reorder the products of a collection. +Reorder the products of a collection. Requires one of the following permissions: MANAGE_PRODUCTS. """ type CollectionReorderProducts @doc(category: "Products") { """Collection from which products are reordered.""" collection: Collection - collectionErrors: [CollectionError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + collectionErrors: [CollectionError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CollectionError!]! } @@ -22457,36 +21728,36 @@ input MoveProductInput @doc(category: "Products") { } """ -Deletes collections. +Deletes collections. Requires one of the following permissions: MANAGE_PRODUCTS. """ type CollectionBulkDelete @doc(category: "Products") { """Returns how many objects were affected.""" count: Int! - collectionErrors: [CollectionError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + collectionErrors: [CollectionError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CollectionError!]! } """ -Remove products from a collection. +Remove products from a collection. Requires one of the following permissions: MANAGE_PRODUCTS. """ type CollectionRemoveProducts @doc(category: "Products") { """Collection from which products will be removed.""" collection: Collection - collectionErrors: [CollectionError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + collectionErrors: [CollectionError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CollectionError!]! } """ -Updates a collection. +Updates a collection. Requires one of the following permissions: MANAGE_PRODUCTS. """ type CollectionUpdate @doc(category: "Products") { - collectionErrors: [CollectionError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + collectionErrors: [CollectionError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CollectionError!]! collection: Collection } @@ -22503,7 +21774,7 @@ input CollectionInput @doc(category: "Products") { """ Description of the collection. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString @@ -22517,48 +21788,44 @@ input CollectionInput @doc(category: "Products") { """Search engine optimization fields.""" seo: SeoInput - """ - Publication date. ISO 8601 standard. - - DEPRECATED: this field will be removed in Saleor 4.0. - """ - publicationDate: Date + """Publication date. ISO 8601 standard.""" + publicationDate: Date @deprecated """ - Fields required to update the collection metadata. - - Added in Saleor 3.8. + Fields required to update the collection metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Fields required to update the collection private metadata. - - Added in Saleor 3.8. + Fields required to update the collection private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] } """ -Creates/updates translations for a collection. +Creates/updates translations for a collection. Requires one of the following permissions: MANAGE_TRANSLATIONS. """ type CollectionTranslate @doc(category: "Products") { - translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.") errors: [TranslationError!]! collection: Collection } """ -Manage collection's availability in channels. +Manage collection's availability in channels. Requires one of the following permissions: MANAGE_PRODUCTS. """ type CollectionChannelListingUpdate @doc(category: "Products") { """An updated collection instance.""" collection: Collection - collectionChannelListingErrors: [CollectionChannelListingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + collectionChannelListingErrors: [CollectionChannelListingError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CollectionChannelListingError!]! } @@ -22599,28 +21866,20 @@ input PublishableChannelListingInput @doc(category: "Products") { """Determines if object is visible to customers.""" isPublished: Boolean - """ - Publication date. ISO 8601 standard. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead. - """ - publicationDate: Date + """Publication date. ISO 8601 standard.""" + publicationDate: Date @deprecated(reason: "Use `publishedAt` field instead.") - """ - Publication date time. ISO 8601 standard. - - Added in Saleor 3.3. - """ + """Publication date time. ISO 8601 standard.""" publishedAt: DateTime } """ -Creates a new product. +Creates a new product. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductCreate @doc(category: "Products") { - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! product: Product } @@ -22632,19 +21891,15 @@ input ProductCreateInput @doc(category: "Products") { """ID of the product's category.""" category: ID - """ - Determine if taxes are being charged for the product. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to configure whether tax collection is enabled. - """ - chargeTaxes: Boolean + """Determine if taxes are being charged for the product.""" + chargeTaxes: Boolean @deprecated(reason: "Use `Channel.taxConfiguration` to configure whether tax collection is enabled.") """List of IDs of collections that the product belongs to.""" collections: [ID!] """ Product description. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString @@ -22660,12 +21915,8 @@ input ProductCreateInput @doc(category: "Products") { """ taxClass: ID - """ - Tax rate for enabled tax gateway. - - DEPRECATED: this field will be removed in Saleor 4.0. Use tax classes to control the tax calculation for a product. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned. - """ - taxCode: String + """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.") """Search engine optimization fields.""" seo: SeoInput @@ -22677,24 +21928,20 @@ input ProductCreateInput @doc(category: "Products") { rating: Float """ - Fields required to update the product metadata. - - Added in Saleor 3.8. + Fields required to update the product metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Fields required to update the product private metadata. - - Added in Saleor 3.8. + Fields required to update the product private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] - """ - External ID of this product. - - Added in Saleor 3.10. - """ + """External ID of this product.""" externalReference: String """ID of the type that product belongs to.""" @@ -22705,44 +21952,24 @@ input AttributeValueInput @doc(category: "Attributes") { """ID of the selected attribute.""" id: ID - """ - External ID of this attribute. - - Added in Saleor 3.14. - """ + """External ID of this attribute.""" externalReference: String """ - The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created. This field will be removed in Saleor 4.0. + The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created. """ - values: [String!] + values: [String!] @deprecated - """ - Attribute value ID or external reference. - - Added in Saleor 3.9. - """ + """Attribute value ID or external reference.""" dropdown: AttributeValueSelectableTypeInput - """ - Attribute value ID or external reference. - - Added in Saleor 3.9. - """ + """Attribute value ID or external reference.""" swatch: AttributeValueSelectableTypeInput - """ - List of attribute value IDs or external references. - - Added in Saleor 3.9. - """ + """List of attribute value IDs or external references.""" multiselect: [AttributeValueSelectableTypeInput!] - """ - Numeric value of an attribute. - - Added in Saleor 3.9. - """ + """Numeric value of an attribute.""" numeric: String """URL of the file attribute. Every time, a new value is created.""" @@ -22751,6 +21978,13 @@ input AttributeValueInput @doc(category: "Attributes") { """File content type.""" contentType: String + """ + ID of the referenced entity for single reference attribute. + + Added in Saleor 3.22. + """ + reference: ID + """List of entity IDs that will be used as references.""" references: [ID!] @@ -22776,18 +22010,12 @@ Represents attribute value. 2. If externalReference is provided, then attribute value will be resolved by external reference. 3. If value is provided, then attribute value will be resolved by value. If this attribute value doesn't exist, then it will be created. 4. If externalReference and value is provided then new attribute value will be created. - -Added in Saleor 3.9. """ input AttributeValueSelectableTypeInput @doc(category: "Attributes") { """ID of an attribute value.""" id: ID - """ - External reference of an attribute value. - - Added in Saleor 3.14. - """ + """External reference of an attribute value.""" externalReference: String """ @@ -22797,12 +22025,12 @@ input AttributeValueSelectableTypeInput @doc(category: "Attributes") { } """ -Deletes a product. +Deletes a product. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductDelete @doc(category: "Products") { - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! product: Product } @@ -22810,10 +22038,6 @@ type ProductDelete @doc(category: "Products") { """ Creates products. -Added in Saleor 3.13. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductBulkCreate @doc(category: "Products") { @@ -22858,7 +22082,6 @@ type ProductBulkCreateError @doc(category: "Products") { channels: [ID!] } -"""An enumeration.""" enum ProductBulkCreateErrorCode @doc(category: "Products") { ATTRIBUTE_ALREADY_ASSIGNED ATTRIBUTE_CANNOT_BE_ASSIGNED @@ -22884,19 +22107,15 @@ input ProductBulkCreateInput @doc(category: "Products") { """ID of the product's category.""" category: ID - """ - Determine if taxes are being charged for the product. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to configure whether tax collection is enabled. - """ - chargeTaxes: Boolean + """Determine if taxes are being charged for the product.""" + chargeTaxes: Boolean @deprecated(reason: "Use `Channel.taxConfiguration` to configure whether tax collection is enabled.") """List of IDs of collections that the product belongs to.""" collections: [ID!] """ Product description. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString @@ -22912,12 +22131,8 @@ input ProductBulkCreateInput @doc(category: "Products") { """ taxClass: ID - """ - Tax rate for enabled tax gateway. - - DEPRECATED: this field will be removed in Saleor 4.0. Use tax classes to control the tax calculation for a product. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned. - """ - taxCode: String + """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.") """Search engine optimization fields.""" seo: SeoInput @@ -22928,10 +22143,18 @@ input ProductBulkCreateInput @doc(category: "Products") { """Defines the product rating value.""" rating: Float - """Fields required to update the product metadata.""" + """ + Fields required to update the product metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ metadata: [MetadataInput!] - """Fields required to update the product private metadata.""" + """ + Fields required to update the product private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ privateMetadata: [MetadataInput!] """External ID of this product.""" @@ -23005,39 +22228,29 @@ input ProductVariantBulkCreateInput @doc(category: "Products") { """Weight of the Product Variant.""" weight: WeightScalar - """ - Determines if variant is in preorder. - - Added in Saleor 3.1. - """ + """Determines if variant is in preorder.""" preorder: PreorderSettingsInput """ Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. - - Added in Saleor 3.1. """ quantityLimitPerCustomer: Int """ - Fields required to update the product variant metadata. - - Added in Saleor 3.8. + Fields required to update the product variant metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Fields required to update the product variant private metadata. - - Added in Saleor 3.8. + Fields required to update the product variant private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] - """ - External ID of this product variant. - - Added in Saleor 3.10. - """ + """External ID of this product variant.""" externalReference: String """Stocks of a product available for sale.""" @@ -23051,79 +22264,46 @@ input BulkAttributeValueInput @doc(category: "Products") { """ID of the selected attribute.""" id: ID - """ - External ID of this attribute. - - Added in Saleor 3.14. - """ + """External ID of this attribute.""" externalReference: String """ - The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created.This field will be removed in Saleor 4.0. + The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created. """ - values: [String!] + values: [String!] @deprecated - """ - Attribute value ID. - - Added in Saleor 3.12. - """ + """Attribute value ID.""" dropdown: AttributeValueSelectableTypeInput - """ - Attribute value ID. - - Added in Saleor 3.12. - """ + """Attribute value ID.""" swatch: AttributeValueSelectableTypeInput - """ - List of attribute value IDs. - - Added in Saleor 3.12. - """ + """List of attribute value IDs.""" multiselect: [AttributeValueSelectableTypeInput!] - """ - Numeric value of an attribute. - - Added in Saleor 3.12. - """ + """Numeric value of an attribute.""" numeric: String - """ - URL of the file attribute. Every time, a new value is created. - - Added in Saleor 3.12. - """ + """URL of the file attribute. Every time, a new value is created.""" file: String - """ - File content type. - - Added in Saleor 3.12. - """ + """File content type.""" contentType: String """ - List of entity IDs that will be used as references. - - Added in Saleor 3.12. + ID of the referenced entity for single reference attribute. + + Added in Saleor 3.22. """ + reference: ID + + """List of entity IDs that will be used as references.""" references: [ID!] - """ - Text content in JSON format. - - Added in Saleor 3.12. - """ + """Text content in JSON format.""" richText: JSONString - """ - Plain text content. - - Added in Saleor 3.12. - """ + """Plain text content.""" plainText: String """ @@ -23131,18 +22311,10 @@ input BulkAttributeValueInput @doc(category: "Products") { """ boolean: Boolean - """ - Represents the date value of the attribute value. - - Added in Saleor 3.12. - """ + """Represents the date value of the attribute value.""" date: Date - """ - Represents the date/time value of the attribute value. - - Added in Saleor 3.12. - """ + """Represents the date/time value of the attribute value.""" dateTime: DateTime } @@ -23173,32 +22345,35 @@ input ProductVariantChannelListingAddInput @doc(category: "Products") { costPrice: PositiveDecimal """ - The threshold for preorder variant in channel. - - Added in Saleor 3.1. + Previous price of the variant in channel. Useful for providing promotion information required by customer protection laws such as EU Omnibus directive. + + Added in Saleor 3.21. """ + priorPrice: PositiveDecimal + + """The threshold for preorder variant in channel.""" preorderThreshold: Int } """ -Deletes products. +Deletes products. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductBulkDelete @doc(category: "Products") { """Returns how many objects were affected.""" count: Int! - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } """ -Updates an existing product. +Updates an existing product. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductUpdate @doc(category: "Products") { - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! product: Product } @@ -23210,19 +22385,15 @@ input ProductInput @doc(category: "Products") { """ID of the product's category.""" category: ID - """ - Determine if taxes are being charged for the product. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `Channel.taxConfiguration` to configure whether tax collection is enabled. - """ - chargeTaxes: Boolean + """Determine if taxes are being charged for the product.""" + chargeTaxes: Boolean @deprecated(reason: "Use `Channel.taxConfiguration` to configure whether tax collection is enabled.") """List of IDs of collections that the product belongs to.""" collections: [ID!] """ Product description. - + Rich text format. For reference see https://editorjs.io/ """ description: JSONString @@ -23238,12 +22409,8 @@ input ProductInput @doc(category: "Products") { """ taxClass: ID - """ - Tax rate for enabled tax gateway. - - DEPRECATED: this field will be removed in Saleor 4.0. Use tax classes to control the tax calculation for a product. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned. - """ - taxCode: String + """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.") """Search engine optimization fields.""" seo: SeoInput @@ -23255,34 +22422,26 @@ input ProductInput @doc(category: "Products") { rating: Float """ - Fields required to update the product metadata. - - Added in Saleor 3.8. + Fields required to update the product metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Fields required to update the product private metadata. - - Added in Saleor 3.8. + Fields required to update the product private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] - """ - External ID of this product. - - Added in Saleor 3.10. - """ + """External ID of this product.""" externalReference: String } """ Creates/updates translations for products. -Added in Saleor 3.15. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: MANAGE_TRANSLATIONS. Triggers the following webhook events: @@ -23319,7 +22478,6 @@ type ProductBulkTranslateError { code: ProductTranslateErrorCode! } -"""An enumeration.""" enum ProductTranslateErrorCode @doc(category: "Products") { GRAPHQL_ERROR INVALID @@ -23342,25 +22500,25 @@ input ProductBulkTranslateInput @doc(category: "Products") { } """ -Creates/updates translations for a product. +Creates/updates translations for a product. Requires one of the following permissions: MANAGE_TRANSLATIONS. """ type ProductTranslate @doc(category: "Products") { - translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.") errors: [TranslationError!]! product: Product } """ -Manage product's availability in channels. +Manage product's availability in channels. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductChannelListingUpdate @doc(category: "Products") { """An updated product instance.""" product: Product - productChannelListingErrors: [ProductChannelListingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productChannelListingErrors: [ProductChannelListingError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductChannelListingError!]! } @@ -23404,18 +22562,10 @@ input ProductChannelListingAddInput @doc(category: "Products") { """Determines if object is visible to customers.""" isPublished: Boolean - """ - Publication date. ISO 8601 standard. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead. - """ - publicationDate: Date + """Publication date. ISO 8601 standard.""" + publicationDate: Date @deprecated(reason: "Use `publishedAt` field instead.") - """ - Publication date time. ISO 8601 standard. - - Added in Saleor 3.3. - """ + """Publication date time. ISO 8601 standard.""" publishedAt: DateTime """ @@ -23429,16 +22579,12 @@ 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. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `availableForPurchaseAt` field instead. + 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. """ - availableForPurchaseDate: Date + availableForPurchaseDate: Date @deprecated(reason: "Use `availableForPurchaseAt` field instead.") """ A start date time from which a product will be available for purchase. When not set and `isAvailable` is set to True, the current day is assumed. - - Added in Saleor 3.3. """ availableForPurchaseAt: DateTime @@ -23450,14 +22596,14 @@ input ProductChannelListingAddInput @doc(category: "Products") { } """ -Create a media object (image or video URL) associated with product. For image, this mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec +Create a media object (image or video URL) associated with product. For image, this mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductMediaCreate @doc(category: "Products") { product: Product media: ProductMedia - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } @@ -23476,13 +22622,13 @@ input ProductMediaCreateInput @doc(category: "Products") { } """ -Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook. +Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductVariantReorder @doc(category: "Products") { product: Product - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } @@ -23497,50 +22643,50 @@ input ReorderInput { } """ -Deletes a product media. +Deletes a product media. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductMediaDelete @doc(category: "Products") { product: Product media: ProductMedia - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } """ -Deletes product media. +Deletes product media. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductMediaBulkDelete @doc(category: "Products") { """Returns how many objects were affected.""" count: Int! - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } """ -Changes ordering of the product media. +Changes ordering of the product media. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductMediaReorder @doc(category: "Products") { product: Product media: [ProductMedia!] - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } """ -Updates a product media. +Updates a product media. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductMediaUpdate @doc(category: "Products") { product: Product media: ProductMedia - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } @@ -23550,12 +22696,12 @@ input ProductMediaUpdateInput @doc(category: "Products") { } """ -Creates a new product type. +Creates a new product type. Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. """ type ProductTypeCreate @doc(category: "Products") { - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! productType: ProductType } @@ -23592,12 +22738,8 @@ input ProductTypeInput @doc(category: "Products") { """Weight of the ProductType items.""" weight: WeightScalar - """ - Tax rate for enabled tax gateway. - - DEPRECATED: this field will be removed in Saleor 4.0.. Use tax classes to control the tax calculation for a product type. If taxCode is provided, Saleor will try to find a tax class with given code (codes are stored in metadata) and assign it. If no tax class is found, it would be created and assigned. - """ - taxCode: String + """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.") """ 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. @@ -23606,72 +22748,72 @@ input ProductTypeInput @doc(category: "Products") { } """ -Deletes a product type. +Deletes a product type. Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. """ type ProductTypeDelete @doc(category: "Products") { - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! productType: ProductType } """ -Deletes product types. +Deletes product types. Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. """ type ProductTypeBulkDelete @doc(category: "Products") { """Returns how many objects were affected.""" count: Int! - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } """ -Updates an existing product type. +Updates an existing product type. Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. """ type ProductTypeUpdate @doc(category: "Products") { - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! productType: ProductType } """ -Reorder the attributes of a product type. +Reorder the attributes of a product type. Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. """ type ProductTypeReorderAttributes @doc(category: "Products") { """Product type from which attributes are reordered.""" productType: ProductType - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } """ -Reorder product attribute values. +Reorder product attribute values. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductReorderAttributeValues @doc(category: "Products") { """Product from which attribute values are reordered.""" product: Product - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } """ -Create new digital content. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec +Create new digital content. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec Requires one of the following permissions: MANAGE_PRODUCTS. """ type DigitalContentCreate @doc(category: "Products") { variant: ProductVariant content: DigitalContent - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } @@ -23693,16 +22835,16 @@ input DigitalContentUploadInput @doc(category: "Products") { automaticFulfillment: Boolean """ - Fields required to update the digital content metadata. - - Added in Saleor 3.8. + Fields required to update the digital content metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Fields required to update the digital content private metadata. - - Added in Saleor 3.8. + Fields required to update the digital content private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] @@ -23711,25 +22853,25 @@ input DigitalContentUploadInput @doc(category: "Products") { } """ -Remove digital content assigned to given variant. +Remove digital content assigned to given variant. Requires one of the following permissions: MANAGE_PRODUCTS. """ type DigitalContentDelete @doc(category: "Products") { variant: ProductVariant - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } """ -Update digital content. +Updates digital content. Requires one of the following permissions: MANAGE_PRODUCTS. """ type DigitalContentUpdate @doc(category: "Products") { variant: ProductVariant content: DigitalContent - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } @@ -23751,27 +22893,27 @@ input DigitalContentInput @doc(category: "Products") { automaticFulfillment: Boolean """ - Fields required to update the digital content metadata. - - Added in Saleor 3.8. + Fields required to update the digital content metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Fields required to update the digital content private metadata. - - Added in Saleor 3.8. + Fields required to update the digital content private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] } """ -Generate new URL to digital content. +Generate new URL to digital content. Requires one of the following permissions: MANAGE_PRODUCTS. """ type DigitalContentUrlCreate @doc(category: "Products") { - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! digitalContentUrl: DigitalContentUrl } @@ -23782,12 +22924,12 @@ input DigitalContentUrlCreateInput @doc(category: "Products") { } """ -Creates a new variant for a product. +Creates a new variant for a product. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductVariantCreate @doc(category: "Products") { - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! productVariant: ProductVariant } @@ -23810,39 +22952,29 @@ input ProductVariantCreateInput @doc(category: "Products") { """Weight of the Product Variant.""" weight: WeightScalar - """ - Determines if variant is in preorder. - - Added in Saleor 3.1. - """ + """Determines if variant is in preorder.""" preorder: PreorderSettingsInput """ Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. - - Added in Saleor 3.1. """ quantityLimitPerCustomer: Int """ - Fields required to update the product variant metadata. - - Added in Saleor 3.8. + Fields required to update the product variant metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Fields required to update the product variant private metadata. - - Added in Saleor 3.8. + Fields required to update the product variant private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] - """ - External ID of this product variant. - - Added in Saleor 3.10. - """ + """External ID of this product variant.""" externalReference: String """Product ID of which type is the variant.""" @@ -23853,18 +22985,18 @@ input ProductVariantCreateInput @doc(category: "Products") { } """ -Deletes a product variant. +Deletes a product variant. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductVariantDelete @doc(category: "Products") { - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! productVariant: ProductVariant } """ -Creates product variants for a given product. +Creates product variants for a given product. Requires one of the following permissions: MANAGE_PRODUCTS. """ @@ -23872,16 +23004,12 @@ type ProductVariantBulkCreate @doc(category: "Products") { """Returns how many objects were created.""" count: Int! - """List of the created variants.This field will be removed in Saleor 4.0.""" + """List of the created variants.""" productVariants: [ProductVariant!]! - """ - List of the created variants. - - Added in Saleor 3.11. - """ + """List of the created variants.""" results: [ProductVariantBulkResult!]! - bulkProductErrors: [BulkProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + bulkProductErrors: [BulkProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [BulkProductError!]! } @@ -23907,8 +23035,6 @@ type ProductVariantBulkError @doc(category: "Products") { """ Path to field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. - - Added in Saleor 3.14. """ path: String @@ -23921,25 +23047,16 @@ type ProductVariantBulkError @doc(category: "Products") { """List of warehouse IDs which causes the error.""" warehouses: [ID!] - """ - List of stocks IDs which causes the error. - - Added in Saleor 3.12. - """ + """List of stocks IDs which causes the error.""" stocks: [ID!] - """ - List of channel IDs which causes the error. - - Added in Saleor 3.12. - """ + """List of channel IDs which causes the error.""" channels: [ID!] """List of channel listings IDs which causes the error.""" channelListings: [ID!] } -"""An enumeration.""" enum ProductVariantBulkErrorCode @doc(category: "Products") { ATTRIBUTE_ALREADY_ASSIGNED ATTRIBUTE_CANNOT_BE_ASSIGNED @@ -23985,11 +23102,7 @@ type BulkProductError @doc(category: "Products") { } """ -Update multiple product variants. - -Added in Saleor 3.11. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. +Updates multiple product variants. Requires one of the following permissions: MANAGE_PRODUCTS. """ @@ -24002,11 +23115,7 @@ type ProductVariantBulkUpdate @doc(category: "Products") { errors: [ProductVariantBulkError!]! } -""" -Input fields to update product variants. - -Added in Saleor 3.11. -""" +"""Input fields to update product variants.""" input ProductVariantBulkUpdateInput @doc(category: "Products") { """List of attributes specific to this variant.""" attributes: [BulkAttributeValueInput!] @@ -24025,57 +23134,35 @@ input ProductVariantBulkUpdateInput @doc(category: "Products") { """Weight of the Product Variant.""" weight: WeightScalar - """ - Determines if variant is in preorder. - - Added in Saleor 3.1. - """ + """Determines if variant is in preorder.""" preorder: PreorderSettingsInput """ Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. - - Added in Saleor 3.1. """ quantityLimitPerCustomer: Int """ - Fields required to update the product variant metadata. - - Added in Saleor 3.8. + Fields required to update the product variant metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Fields required to update the product variant private metadata. - - Added in Saleor 3.8. + Fields required to update the product variant private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] - """ - External ID of this product variant. - - Added in Saleor 3.10. - """ + """External ID of this product variant.""" externalReference: String - """ - Stocks input. - - Added in Saleor 3.12. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Stocks input.""" stocks: ProductVariantStocksUpdateInput - """ - Channel listings input. - - Added in Saleor 3.12. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Channel listings input.""" channelListings: ProductVariantChannelListingUpdateInput """ID of the product variant to update.""" @@ -24122,31 +23209,34 @@ input ChannelListingUpdateInput @doc(category: "Products") { """Cost price of the variant in channel.""" costPrice: PositiveDecimal + """Price of the variant before discount.""" + priorPrice: PositiveDecimal + """The threshold for preorder variant in channel.""" preorderThreshold: Int } """ -Deletes product variants. +Deletes product variants. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductVariantBulkDelete @doc(category: "Products") { """Returns how many objects were affected.""" count: Int! - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } """ -Creates stocks for product variant. +Creates stocks for product variant. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductVariantStocksCreate @doc(category: "Products") { """Updated product variant.""" productVariant: ProductVariant - bulkStockErrors: [BulkStockError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + bulkStockErrors: [BulkStockError!]! @deprecated(reason: "Use `errors` field instead.") errors: [BulkStockError!]! } @@ -24173,14 +23263,14 @@ type BulkStockError @doc(category: "Products") { } """ -Delete stocks from product variant. +Deletes stocks from product variant. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductVariantStocksDelete @doc(category: "Products") { """Updated product variant.""" productVariant: ProductVariant - stockErrors: [StockError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + stockErrors: [StockError!]! @deprecated(reason: "Use `errors` field instead.") errors: [StockError!]! } @@ -24197,7 +23287,6 @@ type StockError @doc(category: "Products") { code: StockErrorCode! } -"""An enumeration.""" enum StockErrorCode @doc(category: "Products") { ALREADY_EXISTS GRAPHQL_ERROR @@ -24208,24 +23297,24 @@ enum StockErrorCode @doc(category: "Products") { } """ -Update stocks for product variant. +Updates stocks for product variant. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductVariantStocksUpdate @doc(category: "Products") { """Updated product variant.""" productVariant: ProductVariant - bulkStockErrors: [BulkStockError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + bulkStockErrors: [BulkStockError!]! @deprecated(reason: "Use `errors` field instead.") errors: [BulkStockError!]! } """ -Updates an existing variant for product. +Updates an existing variant for product. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductVariantUpdate @doc(category: "Products") { - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! productVariant: ProductVariant } @@ -24248,60 +23337,50 @@ input ProductVariantInput @doc(category: "Products") { """Weight of the Product Variant.""" weight: WeightScalar - """ - Determines if variant is in preorder. - - Added in Saleor 3.1. - """ + """Determines if variant is in preorder.""" preorder: PreorderSettingsInput """ Determines maximum quantity of `ProductVariant`,that can be bought in a single checkout. - - Added in Saleor 3.1. """ quantityLimitPerCustomer: Int """ - Fields required to update the product variant metadata. - - Added in Saleor 3.8. + Fields required to update the product variant metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Fields required to update the product variant private metadata. - - Added in Saleor 3.8. + Fields required to update the product variant private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] - """ - External ID of this product variant. - - Added in Saleor 3.10. - """ + """External ID of this product variant.""" externalReference: String } """ -Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook. +Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductVariantSetDefault @doc(category: "Products") { product: Product - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } """ -Creates/updates translations for a product variant. +Creates/updates translations for a product variant. Requires one of the following permissions: MANAGE_TRANSLATIONS. """ type ProductVariantTranslate @doc(category: "Products") { - translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.") errors: [TranslationError!]! productVariant: ProductVariant } @@ -24311,11 +23390,7 @@ input NameTranslationInput { } """ -Creates/updates translations for products variants. - -Added in Saleor 3.15. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. +Creates/updates translations for product variants. Requires one of the following permissions: MANAGE_TRANSLATIONS. @@ -24353,7 +23428,6 @@ type ProductVariantBulkTranslateError { code: ProductVariantTranslateErrorCode! } -"""An enumeration.""" enum ProductVariantTranslateErrorCode @doc(category: "Products") { GRAPHQL_ERROR INVALID @@ -24376,34 +23450,32 @@ input ProductVariantBulkTranslateInput @doc(category: "Products") { } """ -Manage product variant prices in channels. +Manage product variant prices in channels. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductVariantChannelListingUpdate @doc(category: "Products") { """An updated product variant instance.""" variant: ProductVariant - productChannelListingErrors: [ProductChannelListingError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productChannelListingErrors: [ProductChannelListingError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductChannelListingError!]! } """ -Reorder product variant attribute values. +Reorder product variant attribute values. Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductVariantReorderAttributeValues @doc(category: "Products") { """Product variant from which attribute values are reordered.""" productVariant: ProductVariant - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } """ Deactivates product variant preorder. It changes all preorder allocation into regular allocation. -Added in Saleor 3.1. - Requires one of the following permissions: MANAGE_PRODUCTS. """ type ProductVariantPreorderDeactivate @doc(category: "Products") { @@ -24413,38 +23485,38 @@ type ProductVariantPreorderDeactivate @doc(category: "Products") { } """ -Assign an media to a product variant. +Assign an media to a product variant. Requires one of the following permissions: MANAGE_PRODUCTS. """ type VariantMediaAssign @doc(category: "Products") { productVariant: ProductVariant media: ProductMedia - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } """ -Unassign an media from a product variant. +Unassign an media from a product variant. Requires one of the following permissions: MANAGE_PRODUCTS. """ type VariantMediaUnassign @doc(category: "Products") { productVariant: ProductVariant media: ProductMedia - productErrors: [ProductError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + productErrors: [ProductError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ProductError!]! } """ -Captures the authorized payment amount. +Captures the authorized payment amount. Requires one of the following permissions: MANAGE_ORDERS. """ type PaymentCapture @doc(category: "Payments") { """Updated payment.""" payment: Payment - paymentErrors: [PaymentError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + paymentErrors: [PaymentError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PaymentError!]! } @@ -24464,7 +23536,6 @@ type PaymentError @doc(category: "Payments") { variants: [ID!] } -"""An enumeration.""" enum PaymentErrorCode @doc(category: "Payments") { BILLING_ADDRESS_NOT_SET GRAPHQL_ERROR @@ -24484,29 +23555,30 @@ enum PaymentErrorCode @doc(category: "Payments") { UNAVAILABLE_VARIANT_IN_CHANNEL NO_CHECKOUT_LINES CHECKOUT_COMPLETION_IN_PROGRESS + CHECKOUT_HAS_TRANSACTION } """ -Refunds the captured payment amount. +Refunds the captured payment amount. Requires one of the following permissions: MANAGE_ORDERS. """ type PaymentRefund @doc(category: "Payments") { """Updated payment.""" payment: Payment - paymentErrors: [PaymentError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + paymentErrors: [PaymentError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PaymentError!]! } """ -Voids the authorized payment. +Voids the authorized payment. Requires one of the following permissions: MANAGE_ORDERS. """ type PaymentVoid @doc(category: "Payments") { """Updated payment.""" payment: Payment - paymentErrors: [PaymentError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + paymentErrors: [PaymentError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PaymentError!]! } @@ -24514,7 +23586,7 @@ type PaymentVoid @doc(category: "Payments") { type PaymentInitialize @doc(category: "Payments") { """Payment that was initialized.""" initializedPayment: PaymentInitialized - paymentErrors: [PaymentError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + paymentErrors: [PaymentError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PaymentError!]! } @@ -24536,7 +23608,7 @@ type PaymentInitialized @doc(category: "Payments") { type PaymentCheckBalance @doc(category: "Payments") { """Response from the gateway.""" data: JSONString - paymentErrors: [PaymentError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + paymentErrors: [PaymentError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PaymentError!]! } @@ -24576,11 +23648,7 @@ input MoneyInput { } """ -Create transaction for checkout or order. - -Added in Saleor 3.4. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. +Creates transaction for checkout or order. Requires one of the following permissions: HANDLE_PAYMENTS. """ @@ -24602,7 +23670,6 @@ type TransactionCreateError @doc(category: "Payments") { code: TransactionCreateErrorCode! } -"""An enumeration.""" enum TransactionCreateErrorCode @doc(category: "Payments") { INVALID GRAPHQL_ERROR @@ -24613,25 +23680,13 @@ enum TransactionCreateErrorCode @doc(category: "Payments") { } input TransactionCreateInput @doc(category: "Payments") { - """ - Payment name of the transaction. - - Added in Saleor 3.13. - """ + """Payment name of the transaction.""" name: String - """ - The message of the transaction. - - Added in Saleor 3.13. - """ + """The message of the transaction.""" message: String - """ - PSP Reference of the transaction. - - Added in Saleor 3.13. - """ + """PSP Reference of the transaction.""" pspReference: String """List of all possible actions for the transaction""" @@ -24646,50 +23701,97 @@ input TransactionCreateInput @doc(category: "Payments") { """Amount refunded by this transaction.""" amountRefunded: MoneyInput - """ - Amount canceled by this transaction. - - Added in Saleor 3.13. - """ + """Amount canceled by this transaction.""" amountCanceled: MoneyInput - """Payment public metadata.""" + """ + Payment public metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ metadata: [MetadataInput!] - """Payment private metadata.""" + """ + Payment private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ privateMetadata: [MetadataInput!] """ The url that will allow to redirect user to payment provider page with transaction event details. - - Added in Saleor 3.13. """ externalUrl: String + + """ + Details of the payment method used for the transaction. + + Added in Saleor 3.22. + """ + paymentMethodDetails: PaymentMethodDetailsInput } -input TransactionEventInput @doc(category: "Payments") { +""" +Details of the payment method used for the transaction. One of `card` or `other` is required. + +Added in Saleor 3.22. +""" +input PaymentMethodDetailsInput { + """Details of the card payment method used for the transaction.""" + card: CardPaymentMethodDetailsInput + + """Details of the non-card payment method used for this transaction.""" + other: OtherPaymentMethodDetailsInput +} + +input CardPaymentMethodDetailsInput { """ - PSP Reference related to this action. - - Added in Saleor 3.13. + Name of the payment method used for the transaction. Max length is 256 characters. """ - pspReference: String + name: String! + + """ + Brand of the payment method used for the transaction. Max length is 40 characters. + """ + brand: String + + """ + First digits of the card used for the transaction. Max length is 4 characters. + """ + firstDigits: String """ - The message related to the event. - - Added in Saleor 3.13. + Last digits of the card used for the transaction. Max length is 4 characters. """ + lastDigits: String + + """ + Expiration month of the card used for the transaction. Value must be between 1 and 12. + """ + expMonth: Int + + """ + Expiration year of the card used for the transaction. Value must be between 2000 and 9999. + """ + expYear: Int +} + +input OtherPaymentMethodDetailsInput { + """Name of the payment method used for the transaction.""" + name: String! +} + +input TransactionEventInput @doc(category: "Payments") { + """PSP Reference related to this action.""" + pspReference: String + + """The message related to the event.""" message: String } """ Update transaction. -Added in Saleor 3.4. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app. """ type TransactionUpdate @doc(category: "Payments") { @@ -24710,7 +23812,6 @@ type TransactionUpdateError @doc(category: "Payments") { code: TransactionUpdateErrorCode! } -"""An enumeration.""" enum TransactionUpdateErrorCode @doc(category: "Payments") { INVALID GRAPHQL_ERROR @@ -24721,25 +23822,13 @@ enum TransactionUpdateErrorCode @doc(category: "Payments") { } input TransactionUpdateInput @doc(category: "Payments") { - """ - Payment name of the transaction. - - Added in Saleor 3.13. - """ + """Payment name of the transaction.""" name: String - """ - The message of the transaction. - - Added in Saleor 3.13. - """ + """The message of the transaction.""" message: String - """ - PSP Reference of the transaction. - - Added in Saleor 3.13. - """ + """PSP Reference of the transaction.""" pspReference: String """List of all possible actions for the transaction""" @@ -24754,34 +23843,39 @@ input TransactionUpdateInput @doc(category: "Payments") { """Amount refunded by this transaction.""" amountRefunded: MoneyInput - """ - Amount canceled by this transaction. - - Added in Saleor 3.13. - """ + """Amount canceled by this transaction.""" amountCanceled: MoneyInput - """Payment public metadata.""" + """ + Payment public metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ metadata: [MetadataInput!] - """Payment private metadata.""" + """ + Payment private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ privateMetadata: [MetadataInput!] """ The url that will allow to redirect user to payment provider page with transaction event details. - - Added in Saleor 3.13. """ externalUrl: String + + """ + Details of the payment method used for the transaction. + + Added in Saleor 3.22. + """ + paymentMethodDetails: PaymentMethodDetailsInput } """ Request an action for payment transaction. -Added in Saleor 3.4. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: HANDLE_PAYMENTS. """ type TransactionRequestAction @doc(category: "Payments") { @@ -24802,9 +23896,9 @@ type TransactionRequestActionError @doc(category: "Payments") { code: TransactionRequestActionErrorCode! } -"""An enumeration.""" enum TransactionRequestActionErrorCode @doc(category: "Payments") { INVALID + REQUIRED GRAPHQL_ERROR NOT_FOUND MISSING_TRANSACTION_ACTION_REQUEST_WEBHOOK @@ -24813,10 +23907,6 @@ enum TransactionRequestActionErrorCode @doc(category: "Payments") { """ Request a refund for payment transaction based on granted refund. -Added in Saleor 3.15. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: HANDLE_PAYMENTS. """ type TransactionRequestRefundForGrantedRefund @doc(category: "Payments") { @@ -24837,7 +23927,6 @@ type TransactionRequestRefundForGrantedRefundError @doc(category: "Payments") { code: TransactionRequestRefundForGrantedRefundErrorCode! } -"""An enumeration.""" enum TransactionRequestRefundForGrantedRefundErrorCode @doc(category: "Payments") { INVALID GRAPHQL_ERROR @@ -24851,13 +23940,14 @@ enum TransactionRequestRefundForGrantedRefundErrorCode @doc(category: "Payments" """ Report the event for the transaction. -Added in Saleor 3.13. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires the following permissions: OWNER and HANDLE_PAYMENTS for apps, HANDLE_PAYMENTS for staff users. Staff user cannot update a transaction that is owned by the app. + +Triggers the following webhook events: +- TRANSACTION_ITEM_METADATA_UPDATED (async): Optionally called when transaction's metadata was updated. +- 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") { +type TransactionEventReport @doc(category: "Payments") @webhookEventsInfo(asyncEvents: [TRANSACTION_ITEM_METADATA_UPDATED, CHECKOUT_FULLY_PAID, ORDER_UPDATED], syncEvents: []) { """Defines if the reported event hasn't been processed earlier.""" alreadyProcessed: Boolean @@ -24884,21 +23974,17 @@ type TransactionEventReportError @doc(category: "Payments") { code: TransactionEventReportErrorCode! } -"""An enumeration.""" enum TransactionEventReportErrorCode @doc(category: "Payments") { INVALID GRAPHQL_ERROR NOT_FOUND INCORRECT_DETAILS ALREADY_EXISTS + REQUIRED } """ 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. - -Added in Saleor 3.13. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. """ type PaymentGatewayInitialize @doc(category: "Payments") { """List of payment gateway configurations.""" @@ -24928,7 +24014,6 @@ type PaymentGatewayConfigError @doc(category: "Payments") { code: PaymentGatewayConfigErrorCode! } -"""An enumeration.""" enum PaymentGatewayConfigErrorCode @doc(category: "Payments") { GRAPHQL_ERROR INVALID @@ -24948,7 +24033,6 @@ type PaymentGatewayInitializeError @doc(category: "Payments") { code: PaymentGatewayInitializeErrorCode! } -"""An enumeration.""" enum PaymentGatewayInitializeErrorCode @doc(category: "Payments") { GRAPHQL_ERROR INVALID @@ -24965,10 +24049,6 @@ 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. - -Added in Saleor 3.13. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. """ type TransactionInitialize @doc(category: "Payments") { """The initialized transaction.""" @@ -24995,7 +24075,6 @@ type TransactionInitializeError @doc(category: "Payments") { code: TransactionInitializeErrorCode! } -"""An enumeration.""" enum TransactionInitializeErrorCode @doc(category: "Payments") { GRAPHQL_ERROR INVALID @@ -25005,11 +24084,7 @@ enum TransactionInitializeErrorCode @doc(category: "Payments") { } """ -Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. - -Added in Saleor 3.13. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. +Processes a transaction session. It triggers the webhook `TRANSACTION_PROCESS_SESSION`, to the assigned `paymentGateways`. """ type TransactionProcess @doc(category: "Payments") { """The processed transaction.""" @@ -25036,7 +24111,6 @@ type TransactionProcessError @doc(category: "Payments") { code: TransactionProcessErrorCode! } -"""An enumeration.""" enum TransactionProcessErrorCode @doc(category: "Payments") { GRAPHQL_ERROR INVALID @@ -25050,10 +24124,6 @@ enum TransactionProcessErrorCode @doc(category: "Payments") { """ Request to delete a stored payment method on payment provider side. -Added in Saleor 3.16. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: AUTHENTICATED_USER. Triggers the following webhook events: @@ -25093,7 +24163,6 @@ type PaymentMethodRequestDeleteError @doc(category: "Payments") { code: StoredPaymentMethodRequestDeleteErrorCode! } -"""An enumeration.""" enum StoredPaymentMethodRequestDeleteErrorCode @doc(category: "Payments") { GRAPHQL_ERROR INVALID @@ -25105,10 +24174,6 @@ enum StoredPaymentMethodRequestDeleteErrorCode @doc(category: "Payments") { """ Initializes payment gateway for tokenizing payment method session. -Added in Saleor 3.16. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: AUTHENTICATED_USER. Triggers the following webhook events: @@ -25150,7 +24215,6 @@ type PaymentGatewayInitializeTokenizationError @doc(category: "Payments") { code: PaymentGatewayInitializeTokenizationErrorCode! } -"""An enumeration.""" enum PaymentGatewayInitializeTokenizationErrorCode @doc(category: "Payments") { GRAPHQL_ERROR INVALID @@ -25162,10 +24226,6 @@ enum PaymentGatewayInitializeTokenizationErrorCode @doc(category: "Payments") { """ Tokenize payment method. -Added in Saleor 3.16. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: AUTHENTICATED_USER. Triggers the following webhook events: @@ -25214,7 +24274,6 @@ type PaymentMethodInitializeTokenizationError @doc(category: "Payments") { code: PaymentMethodInitializeTokenizationErrorCode! } -"""An enumeration.""" enum PaymentMethodInitializeTokenizationErrorCode @doc(category: "Payments") { GRAPHQL_ERROR INVALID @@ -25226,10 +24285,6 @@ enum PaymentMethodInitializeTokenizationErrorCode @doc(category: "Payments") { """ Tokenize payment method. -Added in Saleor 3.16. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: AUTHENTICATED_USER. Triggers the following webhook events: @@ -25260,7 +24315,6 @@ type PaymentMethodProcessTokenizationError @doc(category: "Payments") { code: PaymentMethodProcessTokenizationErrorCode! } -"""An enumeration.""" enum PaymentMethodProcessTokenizationErrorCode @doc(category: "Payments") { GRAPHQL_ERROR INVALID @@ -25270,12 +24324,12 @@ enum PaymentMethodProcessTokenizationErrorCode @doc(category: "Payments") { } """ -Creates a new page. +Creates a new page. Requires one of the following permissions: MANAGE_PAGES. """ type PageCreate @doc(category: "Pages") { - pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PageError!]! page: Page } @@ -25299,7 +24353,6 @@ type PageError @doc(category: "Pages") { values: [ID!] } -"""An enumeration.""" enum PageErrorCode @doc(category: "Pages") { GRAPHQL_ERROR INVALID @@ -25319,7 +24372,7 @@ input PageCreateInput @doc(category: "Pages") { """ Page content. - + Rich text format. For reference see https://editorjs.io/ """ content: JSONString @@ -25330,18 +24383,10 @@ input PageCreateInput @doc(category: "Pages") { """Determines if page is visible in the storefront.""" isPublished: Boolean - """ - Publication date. ISO 8601 standard. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead. - """ - publicationDate: String + """Publication date. ISO 8601 standard.""" + publicationDate: String @deprecated(reason: "Use `publishedAt` field instead.") - """ - Publication date time. ISO 8601 standard. - - Added in Saleor 3.3. - """ + """Publication date time. ISO 8601 standard.""" publishedAt: DateTime """Search engine optimization fields.""" @@ -25352,47 +24397,47 @@ input PageCreateInput @doc(category: "Pages") { } """ -Deletes a page. +Deletes a page. Requires one of the following permissions: MANAGE_PAGES. """ type PageDelete @doc(category: "Pages") { - pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PageError!]! page: Page } """ -Deletes pages. +Deletes pages. Requires one of the following permissions: MANAGE_PAGES. """ type PageBulkDelete @doc(category: "Pages") { """Returns how many objects were affected.""" count: Int! - pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PageError!]! } """ -Publish pages. +Publish pages. Requires one of the following permissions: MANAGE_PAGES. """ type PageBulkPublish @doc(category: "Pages") { """Returns how many objects were affected.""" count: Int! - pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PageError!]! } """ -Updates an existing page. +Updates an existing page. Requires one of the following permissions: MANAGE_PAGES. """ type PageUpdate @doc(category: "Pages") { - pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PageError!]! page: Page } @@ -25406,7 +24451,7 @@ input PageInput @doc(category: "Pages") { """ Page content. - + Rich text format. For reference see https://editorjs.io/ """ content: JSONString @@ -25417,18 +24462,10 @@ input PageInput @doc(category: "Pages") { """Determines if page is visible in the storefront.""" isPublished: Boolean - """ - Publication date. ISO 8601 standard. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `publishedAt` field instead. - """ - publicationDate: String + """Publication date. ISO 8601 standard.""" + publicationDate: String @deprecated(reason: "Use `publishedAt` field instead.") - """ - Publication date time. ISO 8601 standard. - - Added in Saleor 3.3. - """ + """Publication date time. ISO 8601 standard.""" publishedAt: DateTime """Search engine optimization fields.""" @@ -25436,36 +24473,37 @@ input PageInput @doc(category: "Pages") { } """ -Creates/updates translations for a page. +Creates/updates translations for a page. Requires one of the following permissions: MANAGE_TRANSLATIONS. """ type PageTranslate @doc(category: "Pages") { - translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.") errors: [TranslationError!]! page: PageTranslatableContent } input PageTranslationInput { + slug: String seoTitle: String seoDescription: String title: String """ Translated page content. - + Rich text format. For reference see https://editorjs.io/ """ content: JSONString } """ -Create a new page type. +Creates a new page type. Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. """ type PageTypeCreate @doc(category: "Pages") { - pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PageError!]! pageType: PageType } @@ -25482,12 +24520,12 @@ input PageTypeCreateInput @doc(category: "Pages") { } """ -Update page type. +Updates page type. Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. """ type PageTypeUpdate @doc(category: "Pages") { - pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PageError!]! pageType: PageType } @@ -25507,95 +24545,95 @@ input PageTypeUpdateInput @doc(category: "Pages") { } """ -Delete a page type. +Deletes a page type. Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. """ type PageTypeDelete @doc(category: "Pages") { - pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PageError!]! pageType: PageType } """ -Delete page types. +Deletes page types. Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. """ type PageTypeBulkDelete @doc(category: "Pages") { """Returns how many objects were affected.""" count: Int! - pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PageError!]! } """ -Assign attributes to a given page type. +Assign attributes to a given page type. Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. """ type PageAttributeAssign @doc(category: "Pages") { """The updated page type.""" pageType: PageType - pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PageError!]! } """ -Unassign attributes from a given page type. +Unassign attributes from a given page type. Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. """ type PageAttributeUnassign @doc(category: "Pages") { """The updated page type.""" pageType: PageType - pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PageError!]! } """ -Reorder the attributes of a page type. +Reorder the attributes of a page type. Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. """ type PageTypeReorderAttributes @doc(category: "Pages") { """Page type from which attributes are reordered.""" pageType: PageType - pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PageError!]! } """ -Reorder page attribute values. +Reorder page attribute values. Requires one of the following permissions: MANAGE_PAGES. """ type PageReorderAttributeValues @doc(category: "Pages") { """Page from which attribute values are reordered.""" page: Page - pageErrors: [PageError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + pageErrors: [PageError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PageError!]! } """ -Completes creating an order. +Completes creating an order. Requires one of the following permissions: MANAGE_ORDERS. """ type DraftOrderComplete @doc(category: "Orders") { """Completed order.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } """ -Creates a new draft order. +Creates a new draft order. Requires one of the following permissions: MANAGE_ORDERS. """ type DraftOrderCreate @doc(category: "Orders") { - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! order: Order } @@ -25604,6 +24642,13 @@ input DraftOrderCreateInput @doc(category: "Orders") { """Billing address of the customer.""" billingAddress: AddressInput + """ + Indicates whether the billing address should be saved to the user’s address book upon draft order completion. Can only be set when a billing address is provided. If not specified along with the address, the default behavior is to not save the address. + + Added in Saleor 3.21. + """ + saveBillingAddress: Boolean + """Customer associated with the draft order.""" user: ID @@ -25611,11 +24656,18 @@ input DraftOrderCreateInput @doc(category: "Orders") { userEmail: String """Discount amount for the order.""" - discount: PositiveDecimal + discount: PositiveDecimal @deprecated(reason: "Providing a value for the field has no effect. Use `orderDiscountAdd` mutation instead.") """Shipping address of the customer.""" shippingAddress: AddressInput + """ + Indicates whether the shipping address should be saved to the user’s address book upon draft order completion.Can only be set when a shipping address is provided. If not specified along with the address, the default behavior is to not save the address. + + Added in Saleor 3.21. + """ + saveShippingAddress: Boolean + """ID of a selected shipping method.""" shippingMethod: ID @@ -25624,28 +24676,49 @@ input DraftOrderCreateInput @doc(category: "Orders") { """ A code of the voucher associated with the order. - + Added in Saleor 3.18. """ - voucherCode: String + voucherCode: String + + """A note from a customer. Visible by customers in the order summary.""" + customerNote: String + + """ID of the channel associated with the order.""" + channelId: ID + + """ + URL of a view where users should be redirected to see the order details. URL in RFC 1808 format. + """ + redirectUrl: String + + """External ID of this order.""" + externalReference: String + + """ + Order public metadata. - """A note from a customer. Visible by customers in the order summary.""" - customerNote: String + Added in Saleor 3.21. Can be read by any API client authorized to read the object it's attached to. - """ID of the channel associated with the order.""" - channelId: ID + Warning: never store sensitive information, including financial data such as credit card details. + """ + metadata: [MetadataInput!] """ - URL of a view where users should be redirected to see the order details. URL in RFC 1808 format. + Order private metadata. + + Added in Saleor 3.21. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ - redirectUrl: String + privateMetadata: [MetadataInput!] """ - External ID of this order. - - Added in Saleor 3.10. + Order language code. + + Added in Saleor 3.21. """ - externalReference: String + languageCode: LanguageCodeEnum """Variant line input consisting of variant ID and quantity of products.""" lines: [OrderLineCreateInput!] @@ -25659,64 +24732,58 @@ input OrderLineCreateInput @doc(category: "Orders") { variantId: ID! """ - Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. - - Added in Saleor 3.6. + Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. """ forceNewLine: Boolean = false """ Custom price of the item.When the line with the same variant will be provided multiple times, the last price will be used. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ price: PositiveDecimal } """ -Deletes a draft order. +Deletes a draft order. Requires one of the following permissions: MANAGE_ORDERS. """ type DraftOrderDelete @doc(category: "Orders") { - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! order: Order } """ -Deletes draft orders. +Deletes draft orders. Requires one of the following permissions: MANAGE_ORDERS. """ type DraftOrderBulkDelete @doc(category: "Orders") { """Returns how many objects were affected.""" count: Int! - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } """ -Deletes order lines. +Deletes order lines. Requires one of the following permissions: MANAGE_ORDERS. """ type DraftOrderLinesBulkDelete @doc(category: "Orders") { """Returns how many objects were affected.""" count: Int! - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } """ -Updates a draft order. +Updates a draft order. Requires one of the following permissions: MANAGE_ORDERS. """ type DraftOrderUpdate @doc(category: "Orders") { - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! order: Order } @@ -25725,6 +24792,13 @@ input DraftOrderInput @doc(category: "Orders") { """Billing address of the customer.""" billingAddress: AddressInput + """ + Indicates whether the billing address should be saved to the user’s address book upon draft order completion. Can only be set when a billing address is provided. If not specified along with the address, the default behavior is to not save the address. + + Added in Saleor 3.21. + """ + saveBillingAddress: Boolean + """Customer associated with the draft order.""" user: ID @@ -25732,11 +24806,18 @@ input DraftOrderInput @doc(category: "Orders") { userEmail: String """Discount amount for the order.""" - discount: PositiveDecimal + discount: PositiveDecimal @deprecated(reason: "Providing a value for the field has no effect. Use `orderDiscountAdd` mutation instead.") """Shipping address of the customer.""" shippingAddress: AddressInput + """ + Indicates whether the shipping address should be saved to the user’s address book upon draft order completion.Can only be set when a shipping address is provided. If not specified along with the address, the default behavior is to not save the address. + + Added in Saleor 3.21. + """ + saveShippingAddress: Boolean + """ID of a selected shipping method.""" shippingMethod: ID @@ -25745,7 +24826,7 @@ input DraftOrderInput @doc(category: "Orders") { """ A code of the voucher associated with the order. - + Added in Saleor 3.18. """ voucherCode: String @@ -25761,19 +24842,38 @@ input DraftOrderInput @doc(category: "Orders") { """ redirectUrl: String + """External ID of this order.""" + externalReference: String + """ - External ID of this order. - - Added in Saleor 3.10. + Order public metadata. + + Added in Saleor 3.21. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ - externalReference: String + metadata: [MetadataInput!] + + """ + Order private metadata. + + Added in Saleor 3.21. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ + privateMetadata: [MetadataInput!] + + """ + Order language code. + + Added in Saleor 3.21. + """ + languageCode: LanguageCodeEnum } """ Adds note to the order. -DEPRECATED: this mutation will be removed in Saleor 4.0. - Requires one of the following permissions: MANAGE_ORDERS. """ type OrderAddNote @doc(category: "Orders") { @@ -25782,56 +24882,53 @@ type OrderAddNote @doc(category: "Orders") { """Order note created.""" event: OrderEvent - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } input OrderAddNoteInput @doc(category: "Orders") { - """ - Note message. - - DEPRECATED: this field will be removed in Saleor 4.0. - """ + """Note message.""" message: String! } """ -Cancel an order. +Cancel an order. Requires one of the following permissions: MANAGE_ORDERS. """ type OrderCancel @doc(category: "Orders") { """Canceled order.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } """ -Capture an order. +Capture an order. Requires one of the following permissions: MANAGE_ORDERS. """ type OrderCapture @doc(category: "Orders") { """Captured order.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } """ -Confirms an unconfirmed order by changing status to unfulfilled. +Confirms an unconfirmed order by changing status to unfulfilled. Requires one of the following permissions: MANAGE_ORDERS. """ type OrderConfirm @doc(category: "Orders") { + """Order which has been confirmed.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } """ -Creates new fulfillments for an order. +Creates new fulfillments for an order. Requires one of the following permissions: MANAGE_ORDERS. @@ -25847,7 +24944,7 @@ type OrderFulfill @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [FULF """Fulfilled order.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } @@ -25861,11 +24958,7 @@ input OrderFulfillInput @doc(category: "Orders") { """If true, then allow proceed fulfillment when stock is exceeded.""" allowStockToBeExceeded: Boolean = false - """ - Fulfillment tracking number. - - Added in Saleor 3.6. - """ + """Fulfillment tracking number.""" trackingNumber: String } @@ -25886,7 +24979,7 @@ input OrderFulfillStockInput @doc(category: "Orders") { } """ -Cancels existing fulfillment and optionally restocks items. +Cancels existing fulfillment and optionally restocks items. Requires one of the following permissions: MANAGE_ORDERS. """ @@ -25896,7 +24989,7 @@ type FulfillmentCancel @doc(category: "Orders") { """Order which fulfillment was cancelled.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } @@ -25910,8 +25003,6 @@ input FulfillmentCancelInput @doc(category: "Orders") { """ Approve existing fulfillment. -Added in Saleor 3.1. - Requires one of the following permissions: MANAGE_ORDERS. Triggers the following webhook events: @@ -25923,12 +25014,12 @@ type FulfillmentApprove @doc(category: "Orders") @webhookEventsInfo(asyncEvents: """Order which fulfillment was approved.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } """ -Updates a fulfillment for an order. +Updates a fulfillment for an order. Requires one of the following permissions: MANAGE_ORDERS. @@ -25941,7 +25032,7 @@ type FulfillmentUpdateTracking @doc(category: "Orders") @webhookEventsInfo(async """Order for which fulfillment was updated.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } @@ -25954,7 +25045,7 @@ input FulfillmentUpdateTrackingInput @doc(category: "Orders") { } """ -Refund products. +Refund products. Requires one of the following permissions: MANAGE_ORDERS. """ @@ -25964,7 +25055,7 @@ type FulfillmentRefundProducts @doc(category: "Orders") { """Order which fulfillment was refunded.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } @@ -26001,7 +25092,7 @@ input OrderRefundFulfillmentLineInput @doc(category: "Orders") { } """ -Return products. +Return products. Requires one of the following permissions: MANAGE_ORDERS. """ @@ -26017,7 +25108,7 @@ type FulfillmentReturnProducts @doc(category: "Orders") { """A draft order which was created for products with replace flag.""" replaceOrder: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } @@ -26065,10 +25156,6 @@ input OrderReturnFulfillmentLineInput @doc(category: "Orders") { """ Adds granted refund to the order. -Added in Saleor 3.13. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: MANAGE_ORDERS. """ type OrderGrantRefundCreate @doc(category: "Orders") { @@ -26092,17 +25179,10 @@ type OrderGrantRefundCreateError @doc(category: "Orders") { """The error code.""" code: OrderGrantRefundCreateErrorCode! - """ - List of lines which cause the error. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """List of lines which cause the error.""" lines: [OrderGrantRefundCreateLineError!] } -"""An enumeration.""" enum OrderGrantRefundCreateErrorCode @doc(category: "Orders") { GRAPHQL_ERROR NOT_FOUND @@ -26128,7 +25208,6 @@ type OrderGrantRefundCreateLineError { lineId: ID! } -"""An enumeration.""" enum OrderGrantRefundCreateLineErrorCode { GRAPHQL_ERROR NOT_FOUND @@ -26145,31 +25224,26 @@ input OrderGrantRefundCreateInput @doc(category: "Orders") { reason: String """ - Lines to assign to granted refund. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. + ID of a `Page` (Model) to reference in reason. + + Added in Saleor 3.22. """ + reasonReference: ID + + """Lines to assign to granted refund.""" lines: [OrderGrantRefundCreateLineInput!] - """ - Determine if granted refund should include shipping costs. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Determine if granted refund should include shipping costs.""" grantRefundForShipping: Boolean """ - The ID of the transaction item related to the granted refund. If `amount` provided in the input, the transaction.chargedAmount needs to be equal or greater than provided `amount`.If `amount` is not provided in the input and calculated automatically by Saleor, the `min(calculatedAmount, transaction.chargedAmount)` will be used.Field will be required starting from Saleor 3.21. - + The ID of the transaction item related to the granted refund. If `amount` provided in the input, the transaction.chargedAmount needs to be equal or greater than provided `amount`.If `amount` is not provided in the input and calculated automatically by Saleor, the `min(calculatedAmount, transaction.chargedAmount)` will be used. Field required starting from Saleor 3.21. + Added in Saleor 3.20. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ - transactionId: ID + transactionId: ID! } input OrderGrantRefundCreateLineInput @doc(category: "Orders") { @@ -26186,10 +25260,6 @@ input OrderGrantRefundCreateLineInput @doc(category: "Orders") { """ Updates granted refund. -Added in Saleor 3.13. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: MANAGE_ORDERS. """ type OrderGrantRefundUpdate @doc(category: "Orders") { @@ -26213,26 +25283,13 @@ type OrderGrantRefundUpdateError @doc(category: "Orders") { """The error code.""" code: OrderGrantRefundUpdateErrorCode! - """ - List of lines to add which cause the error. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """List of lines to add which cause the error.""" addLines: [OrderGrantRefundUpdateLineError!] - """ - List of lines to remove which cause the error. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """List of lines to remove which cause the error.""" removeLines: [OrderGrantRefundUpdateLineError!] } -"""An enumeration.""" enum OrderGrantRefundUpdateErrorCode @doc(category: "Orders") { GRAPHQL_ERROR NOT_FOUND @@ -26258,7 +25315,6 @@ type OrderGrantRefundUpdateLineError { lineId: ID! } -"""An enumeration.""" enum OrderGrantRefundUpdateLineErrorCode { GRAPHQL_ERROR NOT_FOUND @@ -26275,37 +25331,26 @@ input OrderGrantRefundUpdateInput @doc(category: "Orders") { reason: String """ - Lines to assign to granted refund. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. + ID of a `Page` (Model) to reference in reason. + + Added in Saleor 3.22. """ + reasonReference: ID + + """Lines to assign to granted refund.""" addLines: [OrderGrantRefundUpdateLineAddInput!] - """ - Lines to remove from granted refund. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Lines to remove from granted refund.""" removeLines: [ID!] - """ - Determine if granted refund should include shipping costs. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Determine if granted refund should include shipping costs.""" grantRefundForShipping: Boolean """ The ID of the transaction item related to the granted refund. If `amount` provided in the input, the transaction.chargedAmount needs to be equal or greater than provided `amount`.If `amount` is not provided in the input and calculated automatically by Saleor, the `min(calculatedAmount, transaction.chargedAmount)` will be used.Field will be required starting from Saleor 3.21. - + Added in Saleor 3.20. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ transactionId: ID @@ -26323,7 +25368,7 @@ input OrderGrantRefundUpdateLineAddInput @doc(category: "Orders") { } """ -Create order lines for an order. +Creates order lines for an order. Requires one of the following permissions: MANAGE_ORDERS. """ @@ -26333,12 +25378,12 @@ type OrderLinesCreate @doc(category: "Orders") { """List of added order lines.""" orderLines: [OrderLine!] - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } """ -Deletes an order line from an order. +Deletes an order line from an order. Requires one of the following permissions: MANAGE_ORDERS. """ @@ -26348,19 +25393,19 @@ type OrderLineDelete @doc(category: "Orders") { """An order line that was deleted.""" orderLine: OrderLine - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } """ -Updates an order line of an order. +Updates an order line of an order. Requires one of the following permissions: MANAGE_ORDERS. """ type OrderLineUpdate @doc(category: "Orders") { """Related order.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! orderLine: OrderLine } @@ -26371,14 +25416,14 @@ input OrderLineInput @doc(category: "Orders") { } """ -Adds discount to the order. +Adds discount to the order. Requires one of the following permissions: MANAGE_ORDERS. """ type OrderDiscountAdd @doc(category: "Orders") { """Order which has been discounted.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } @@ -26394,31 +25439,31 @@ input OrderDiscountCommonInput @doc(category: "Orders") { } """ -Update discount for the order. +Update discount for the order. Requires one of the following permissions: MANAGE_ORDERS. """ type OrderDiscountUpdate @doc(category: "Orders") { """Order which has been discounted.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } """ -Remove discount from the order. +Remove discount from the order. Requires one of the following permissions: MANAGE_ORDERS. """ type OrderDiscountDelete @doc(category: "Orders") { """Order which has removed discount.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } """ -Update discount for the order line. +Update discount for the order line. Requires one of the following permissions: MANAGE_ORDERS. """ @@ -26428,12 +25473,12 @@ type OrderLineDiscountUpdate @doc(category: "Orders") { """Order which is related to the discounted line.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } """ -Remove discount applied to the order line. +Remove discount applied to the order line. Requires one of the following permissions: MANAGE_ORDERS. """ @@ -26443,17 +25488,13 @@ type OrderLineDiscountRemove @doc(category: "Orders") { """Order which is related to line which has removed discount.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } """ Adds note to the order. -Added in Saleor 3.15. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: MANAGE_ORDERS. """ type OrderNoteAdd @doc(category: "Orders") { @@ -26478,7 +25519,6 @@ type OrderNoteAddError @doc(category: "Orders") { code: OrderNoteAddErrorCode } -"""An enumeration.""" enum OrderNoteAddErrorCode @doc(category: "Orders") { GRAPHQL_ERROR REQUIRED @@ -26492,10 +25532,6 @@ input OrderNoteInput @doc(category: "Orders") { """ Updates note of an order. -Added in Saleor 3.15. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: MANAGE_ORDERS. """ type OrderNoteUpdate @doc(category: "Orders") { @@ -26520,7 +25556,6 @@ type OrderNoteUpdateError @doc(category: "Orders") { code: OrderNoteUpdateErrorCode } -"""An enumeration.""" enum OrderNoteUpdateErrorCode @doc(category: "Orders") { GRAPHQL_ERROR NOT_FOUND @@ -26528,36 +25563,36 @@ enum OrderNoteUpdateErrorCode @doc(category: "Orders") { } """ -Mark order as manually paid. +Mark order as manually paid. Requires one of the following permissions: MANAGE_ORDERS. """ type OrderMarkAsPaid @doc(category: "Orders") { """Order marked as paid.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } """ -Refund an order. +Refund an order. Requires one of the following permissions: MANAGE_ORDERS. """ type OrderRefund @doc(category: "Orders") { """A refunded order.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } """ -Updates an order. +Updates an order. Requires one of the following permissions: MANAGE_ORDERS. """ type OrderUpdate @doc(category: "Orders") { - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! order: Order } @@ -26572,23 +25607,44 @@ input OrderUpdateInput @doc(category: "Orders") { """Shipping address of the customer.""" shippingAddress: AddressInput + """External ID of this order.""" + externalReference: String + + """ + Order public metadata. + + Added in Saleor 3.21.Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ - External ID of this order. - - Added in Saleor 3.10. + metadata: [MetadataInput!] + """ - externalReference: String + Order private metadata. + + Added in Saleor 3.21.Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ + privateMetadata: [MetadataInput!] + + """ + Order language code. + + Added in Saleor 3.21. + """ + languageCode: LanguageCodeEnum } """ -Updates a shipping method of the order. Requires shipping method ID to update, when null is passed then currently assigned shipping method is removed. +Updates a shipping method of the order. Requires shipping method ID to update, when null is passed then currently assigned shipping method is removed. Requires one of the following permissions: MANAGE_ORDERS. """ type OrderUpdateShipping @doc(category: "Orders") { """Order with updated shipping method.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } @@ -26600,36 +25656,32 @@ input OrderUpdateShippingInput @doc(category: "Orders") { } """ -Void an order. +Void an order. Requires one of the following permissions: MANAGE_ORDERS. """ type OrderVoid @doc(category: "Orders") { """A voided order.""" order: Order - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } """ -Cancels orders. +Cancels orders. Requires one of the following permissions: MANAGE_ORDERS. """ type OrderBulkCancel @doc(category: "Orders") { """Returns how many objects were affected.""" count: Int! - orderErrors: [OrderError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + orderErrors: [OrderError!]! @deprecated(reason: "Use `errors` field instead.") errors: [OrderError!]! } """ Creates multiple orders. -Added in Saleor 3.14. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: MANAGE_ORDERS_IMPORT. """ type OrderBulkCreate @doc(category: "Orders") { @@ -26662,7 +25714,6 @@ type OrderBulkCreateError @doc(category: "Orders") { code: OrderBulkCreateErrorCode } -"""An enumeration.""" enum OrderBulkCreateErrorCode { GRAPHQL_ERROR REQUIRED @@ -26709,10 +25760,18 @@ input OrderBulkCreateInput @doc(category: "Orders") { """Currency code.""" currency: String! - """Metadata of the order.""" + """ + Metadata of the order. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ metadata: [MetadataInput!] - """Private metadata of the order.""" + """ + Private metadata of the order. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ privateMetadata: [MetadataInput!] """Note about customer.""" @@ -26746,7 +25805,7 @@ input OrderBulkCreateInput @doc(category: "Orders") { """ Code of a voucher associated with the order. - + Added in Saleor 3.18. """ voucherCode: String @@ -26811,6 +25870,13 @@ input OrderBulkCreateOrderLineInput @doc(category: "Orders") { """The name of the product.""" productName: String + """ + The SKU of the product. + + Added in Saleor 3.18. + """ + productSku: String + """Translation of the product variant name.""" translatedVariantName: String @@ -26835,13 +25901,42 @@ input OrderBulkCreateOrderLineInput @doc(category: "Orders") { """Price of the order line excluding applied discount.""" undiscountedTotalPrice: TaxedMoneyInput! + """ + Reason of the discount on order line. + + Added in Saleor 3.19. + """ + unitDiscountReason: String + + """ + Type of the discount: fixed or percent + + Added in Saleor 3.19. + """ + unitDiscountType: DiscountValueTypeEnum + + """ + Value of the discount. Can store fixed value or percent value + + Added in Saleor 3.19. + """ + unitDiscountValue: PositiveDecimal + """The ID of the warehouse, where the line will be allocated.""" warehouse: ID! - """Metadata of the order line.""" + """ + Metadata of the order line. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ metadata: [MetadataInput!] - """Private metadata of the order line.""" + """ + Private metadata of the order line. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ privateMetadata: [MetadataInput!] """Tax rate of the order line.""" @@ -26853,10 +25948,18 @@ input OrderBulkCreateOrderLineInput @doc(category: "Orders") { """The name of the tax class.""" taxClassName: String - """Metadata of the tax class.""" + """ + Metadata of the tax class. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ taxClassMetadata: [MetadataInput!] - """Private metadata of the tax class.""" + """ + Private metadata of the tax class. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ taxClassPrivateMetadata: [MetadataInput!] } @@ -26893,10 +25996,18 @@ input OrderBulkCreateDeliveryMethodInput @doc(category: "Orders") { """The name of the tax class.""" shippingTaxClassName: String - """Metadata of the tax class.""" + """ + Metadata of the tax class. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ shippingTaxClassMetadata: [MetadataInput!] - """Private metadata of the tax class.""" + """ + Private metadata of the tax class. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ shippingTaxClassPrivateMetadata: [MetadataInput!] } @@ -26938,10 +26049,18 @@ input OrderBulkCreateInvoiceInput @doc(category: "Orders") { """URL of the invoice to download.""" url: String - """Metadata of the invoice.""" + """ + Metadata of the invoice. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ metadata: [MetadataInput!] - """Private metadata of the invoice.""" + """ + Private metadata of the invoice. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ privateMetadata: [MetadataInput!] } @@ -26962,7 +26081,7 @@ enum StockUpdatePolicyEnum { Delete metadata of an object. To use it, you need to have access to the modified object. """ type DeleteMetadata { - metadataErrors: [MetadataError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + metadataErrors: [MetadataError!]! @deprecated(reason: "Use `errors` field instead.") errors: [MetadataError!]! item: ObjectWithMetadata } @@ -26980,7 +26099,6 @@ type MetadataError { code: MetadataErrorCode! } -"""An enumeration.""" enum MetadataErrorCode { GRAPHQL_ERROR INVALID @@ -26993,38 +26111,42 @@ enum MetadataErrorCode { Delete object's private metadata. To use it, you need to be an authenticated staff user or an app and have access to the modified object. """ type DeletePrivateMetadata { - metadataErrors: [MetadataError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + metadataErrors: [MetadataError!]! @deprecated(reason: "Use `errors` field instead.") errors: [MetadataError!]! item: ObjectWithMetadata } """ -Updates metadata of an object. To use it, you need to have access to the modified object. +Updates metadata of an object.Requires permissions to modify and to read the metadata of the object it's attached to. + +Warning: never store sensitive information, including financial data such as credit card details. """ type UpdateMetadata { - metadataErrors: [MetadataError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + metadataErrors: [MetadataError!]! @deprecated(reason: "Use `errors` field instead.") errors: [MetadataError!]! item: ObjectWithMetadata } """ -Updates private metadata of an object. To use it, you need to be an authenticated staff user or an app and have access to the modified object. +Updates private metadata of an object. Requires permissions to modify and to read the metadata of the object it's attached to. + +Warning: never store sensitive information, including financial data such as credit card details. """ type UpdatePrivateMetadata { - metadataErrors: [MetadataError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + metadataErrors: [MetadataError!]! @deprecated(reason: "Use `errors` field instead.") errors: [MetadataError!]! item: ObjectWithMetadata } """ -Assigns storefront's navigation menus. +Assigns storefront's navigation menus. Requires one of the following permissions: MANAGE_MENUS, MANAGE_SETTINGS. """ type AssignNavigation @doc(category: "Menu") { """Assigned navigation menu.""" menu: Menu - menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.") errors: [MenuError!]! } @@ -27041,7 +26163,6 @@ type MenuError @doc(category: "Menu") { code: MenuErrorCode! } -"""An enumeration.""" enum MenuErrorCode { CANNOT_ASSIGN_NODE GRAPHQL_ERROR @@ -27063,7 +26184,7 @@ enum NavigationType { } """ -Creates a new Menu. +Creates a new Menu. Requires one of the following permissions: MANAGE_MENUS. @@ -27071,7 +26192,7 @@ Triggers the following webhook events: - MENU_CREATED (async): A menu was created. """ type MenuCreate @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_CREATED], syncEvents: []) { - menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.") errors: [MenuError!]! menu: Menu } @@ -27105,7 +26226,7 @@ input MenuItemInput { } """ -Deletes a menu. +Deletes a menu. Requires one of the following permissions: MANAGE_MENUS. @@ -27113,13 +26234,13 @@ Triggers the following webhook events: - MENU_DELETED (async): A menu was deleted. """ type MenuDelete @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_DELETED], syncEvents: []) { - menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.") errors: [MenuError!]! menu: Menu } """ -Deletes menus. +Deletes menus. Requires one of the following permissions: MANAGE_MENUS. @@ -27129,12 +26250,12 @@ Triggers the following webhook events: type MenuBulkDelete @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_DELETED], syncEvents: []) { """Returns how many objects were affected.""" count: Int! - menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.") errors: [MenuError!]! } """ -Updates a menu. +Updates a menu. Requires one of the following permissions: MANAGE_MENUS. @@ -27142,7 +26263,7 @@ Triggers the following webhook events: - MENU_UPDATED (async): A menu was updated. """ type MenuUpdate @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_UPDATED], syncEvents: []) { - menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.") errors: [MenuError!]! menu: Menu } @@ -27156,7 +26277,7 @@ input MenuInput { } """ -Creates a new menu item. +Creates a new menu item. Requires one of the following permissions: MANAGE_MENUS. @@ -27164,7 +26285,7 @@ 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: []) { - menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.") errors: [MenuError!]! menuItem: MenuItem } @@ -27193,7 +26314,7 @@ input MenuItemCreateInput { } """ -Deletes a menu item. +Deletes a menu item. Requires one of the following permissions: MANAGE_MENUS. @@ -27201,13 +26322,13 @@ 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: []) { - menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.") errors: [MenuError!]! menuItem: MenuItem } """ -Deletes menu items. +Deletes menu items. Requires one of the following permissions: MANAGE_MENUS. @@ -27217,12 +26338,12 @@ Triggers the following webhook events: type MenuItemBulkDelete @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_ITEM_DELETED], syncEvents: []) { """Returns how many objects were affected.""" count: Int! - menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.") errors: [MenuError!]! } """ -Updates a menu item. +Updates a menu item. Requires one of the following permissions: MANAGE_MENUS. @@ -27230,24 +26351,24 @@ 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: []) { - menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.") errors: [MenuError!]! menuItem: MenuItem } """ -Creates/updates translations for a menu item. +Creates/updates translations for a menu item. Requires one of the following permissions: MANAGE_TRANSLATIONS. """ type MenuItemTranslate @doc(category: "Menu") { - translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.") errors: [TranslationError!]! menuItem: MenuItem } """ -Moves items of menus. +Moves items of menus. Requires one of the following permissions: MANAGE_MENUS. @@ -27257,7 +26378,7 @@ Triggers the following webhook events: type MenuItemMove @doc(category: "Menu") @webhookEventsInfo(asyncEvents: [MENU_ITEM_UPDATED], syncEvents: []) { """Assigned menu to move within.""" menu: Menu - menuErrors: [MenuError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + menuErrors: [MenuError!]! @deprecated(reason: "Use `errors` field instead.") errors: [MenuError!]! } @@ -27275,7 +26396,7 @@ input MenuItemMoveInput { } """ -Request an invoice for the order using plugin. +Request an invoice for the order using plugin. Requires one of the following permissions: MANAGE_ORDERS. @@ -27285,7 +26406,7 @@ Triggers the following webhook events: type InvoiceRequest @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [INVOICE_REQUESTED], syncEvents: []) { """Order related to an invoice.""" order: Order - invoiceErrors: [InvoiceError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + invoiceErrors: [InvoiceError!]! @deprecated(reason: "Use `errors` field instead.") errors: [InvoiceError!]! invoice: Invoice } @@ -27303,7 +26424,6 @@ type InvoiceError @doc(category: "Orders") { code: InvoiceErrorCode! } -"""An enumeration.""" enum InvoiceErrorCode @doc(category: "Orders") { REQUIRED NOT_READY @@ -27316,7 +26436,7 @@ enum InvoiceErrorCode @doc(category: "Orders") { } """ -Requests deletion of an invoice. +Requests deletion of an invoice. Requires one of the following permissions: MANAGE_ORDERS. @@ -27324,18 +26444,18 @@ Triggers the following webhook events: - INVOICE_DELETED (async): An invoice was requested to delete. """ type InvoiceRequestDelete @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [INVOICE_DELETED], syncEvents: []) { - invoiceErrors: [InvoiceError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + invoiceErrors: [InvoiceError!]! @deprecated(reason: "Use `errors` field instead.") errors: [InvoiceError!]! invoice: Invoice } """ -Creates a ready to send invoice. +Creates a ready to send invoice. Requires one of the following permissions: MANAGE_ORDERS. """ type InvoiceCreate @doc(category: "Orders") { - invoiceErrors: [InvoiceError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + invoiceErrors: [InvoiceError!]! @deprecated(reason: "Use `errors` field instead.") errors: [InvoiceError!]! invoice: Invoice } @@ -27348,38 +26468,38 @@ input InvoiceCreateInput @doc(category: "Orders") { url: String! """ - Fields required to update the invoice metadata. - - Added in Saleor 3.14. + Fields required to update the invoice metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Fields required to update the invoice private metadata. - - Added in Saleor 3.14. + Fields required to update the invoice private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] } """ -Deletes an invoice. +Deletes an invoice. Requires one of the following permissions: MANAGE_ORDERS. """ type InvoiceDelete @doc(category: "Orders") { - invoiceErrors: [InvoiceError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + invoiceErrors: [InvoiceError!]! @deprecated(reason: "Use `errors` field instead.") errors: [InvoiceError!]! invoice: Invoice } """ -Updates an invoice. +Updates an invoice. Requires one of the following permissions: MANAGE_ORDERS. """ type InvoiceUpdate @doc(category: "Orders") { - invoiceErrors: [InvoiceError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + invoiceErrors: [InvoiceError!]! @deprecated(reason: "Use `errors` field instead.") errors: [InvoiceError!]! invoice: Invoice } @@ -27392,22 +26512,22 @@ input UpdateInvoiceInput @doc(category: "Orders") { url: String """ - Fields required to update the invoice metadata. - - Added in Saleor 3.14. + Fields required to update the invoice metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Fields required to update the invoice private metadata. - - Added in Saleor 3.14. + Fields required to update the invoice private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] } """ -Send an invoice notification to the customer. +Send an invoice notification to the customer. Requires one of the following permissions: MANAGE_ORDERS. @@ -27416,13 +26536,13 @@ Triggers the following webhook events: - NOTIFY_USER (async): A notification for invoice send """ type InvoiceSendNotification @doc(category: "Orders") @webhookEventsInfo(asyncEvents: [INVOICE_SENT, NOTIFY_USER], syncEvents: []) { - invoiceErrors: [InvoiceError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + invoiceErrors: [InvoiceError!]! @deprecated(reason: "Use `errors` field instead.") errors: [InvoiceError!]! invoice: Invoice } """ -Activate a gift card. +Activate a gift card. Requires one of the following permissions: MANAGE_GIFT_CARD. @@ -27432,7 +26552,7 @@ Triggers the following webhook events: type GiftCardActivate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_STATUS_CHANGED], syncEvents: []) { """Activated gift card.""" giftCard: GiftCard - giftCardErrors: [GiftCardError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + giftCardErrors: [GiftCardError!]! @deprecated(reason: "Use `errors` field instead.") errors: [GiftCardError!]! } @@ -27452,7 +26572,6 @@ type GiftCardError @doc(category: "Gift cards") { tags: [String!] } -"""An enumeration.""" enum GiftCardErrorCode @doc(category: "Gift cards") { ALREADY_EXISTS GRAPHQL_ERROR @@ -27465,7 +26584,7 @@ enum GiftCardErrorCode @doc(category: "Gift cards") { } """ -Creates a new gift card. +Creates a new gift card. Requires one of the following permissions: MANAGE_GIFT_CARD. @@ -27474,39 +26593,41 @@ Triggers the following webhook events: - NOTIFY_USER (async): A notification for created gift card. """ type GiftCardCreate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_CREATED, NOTIFY_USER], syncEvents: []) { - giftCardErrors: [GiftCardError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + giftCardErrors: [GiftCardError!]! @deprecated(reason: "Use `errors` field instead.") errors: [GiftCardError!]! giftCard: GiftCard } input GiftCardCreateInput @doc(category: "Gift cards") { - """ - The gift card tags to add. - - Added in Saleor 3.1. - """ + """The gift card tags to add.""" addTags: [String!] - """ - The gift card expiry date. - - Added in Saleor 3.1. - """ + """The gift card expiry date.""" expiryDate: Date """ - Start date of the gift card in ISO 8601 format. - - DEPRECATED: this field will be removed in Saleor 4.0. + Gift Card public metadata. + + Added in Saleor 3.21. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ - startDate: Date + metadata: [MetadataInput!] """ - End date of the gift card in ISO 8601 format. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `expiryDate` from `expirySettings` instead. + Gift Card private metadata. + + Added in Saleor 3.21. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ - endDate: Date + privateMetadata: [MetadataInput!] + + """Start date of the gift card in ISO 8601 format.""" + startDate: Date @deprecated + + """End date of the gift card in ISO 8601 format.""" + endDate: Date @deprecated(reason: "Use `expiryDate` from `expirySettings` instead.") """Balance of the gift card.""" balance: PriceInput! @@ -27514,32 +26635,16 @@ input GiftCardCreateInput @doc(category: "Gift cards") { """Email of the customer to whom gift card will be sent.""" userEmail: String - """ - Slug of a channel from which the email should be sent. - - Added in Saleor 3.1. - """ + """Slug of a channel from which the email should be sent.""" channel: String - """ - Determine if gift card is active. - - Added in Saleor 3.1. - """ + """Determine if gift card is active.""" isActive: Boolean! - """ - Code to use the gift card. - - DEPRECATED: this field will be removed in Saleor 4.0. The code is now auto generated. - """ - code: String + """Code to use the gift card.""" + code: String @deprecated(reason: "The code is now auto generated.") - """ - The gift card note from the staff member. - - Added in Saleor 3.1. - """ + """The gift card note from the staff member.""" note: String } @@ -27552,9 +26657,7 @@ input PriceInput { } """ -Delete gift card. - -Added in Saleor 3.1. +Deletes gift card. Requires one of the following permissions: MANAGE_GIFT_CARD. @@ -27562,13 +26665,13 @@ 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: []) { - giftCardErrors: [GiftCardError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + giftCardErrors: [GiftCardError!]! @deprecated(reason: "Use `errors` field instead.") errors: [GiftCardError!]! giftCard: GiftCard } """ -Deactivate a gift card. +Deactivate a gift card. Requires one of the following permissions: MANAGE_GIFT_CARD. @@ -27578,12 +26681,12 @@ Triggers the following webhook events: type GiftCardDeactivate @doc(category: "Gift cards") @webhookEventsInfo(asyncEvents: [GIFT_CARD_STATUS_CHANGED], syncEvents: []) { """Deactivated gift card.""" giftCard: GiftCard - giftCardErrors: [GiftCardError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + giftCardErrors: [GiftCardError!]! @deprecated(reason: "Use `errors` field instead.") errors: [GiftCardError!]! } """ -Update a gift card. +Update a gift card. Requires one of the following permissions: MANAGE_GIFT_CARD. @@ -27591,60 +26694,52 @@ 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: []) { - giftCardErrors: [GiftCardError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + giftCardErrors: [GiftCardError!]! @deprecated(reason: "Use `errors` field instead.") errors: [GiftCardError!]! giftCard: GiftCard } input GiftCardUpdateInput @doc(category: "Gift cards") { - """ - The gift card tags to add. - - Added in Saleor 3.1. - """ + """The gift card tags to add.""" addTags: [String!] - """ - The gift card expiry date. - - Added in Saleor 3.1. - """ + """The gift card expiry date.""" expiryDate: Date """ - Start date of the gift card in ISO 8601 format. - - DEPRECATED: this field will be removed in Saleor 4.0. - """ - startDate: Date + Gift Card public metadata. + Added in Saleor 3.21. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ - End date of the gift card in ISO 8601 format. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `expiryDate` from `expirySettings` instead. - """ - endDate: Date + metadata: [MetadataInput!] """ - The gift card tags to remove. - - Added in Saleor 3.1. + Gift Card private metadata. + + Added in Saleor 3.21. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ + privateMetadata: [MetadataInput!] + + """Start date of the gift card in ISO 8601 format.""" + startDate: Date @deprecated + + """End date of the gift card in ISO 8601 format.""" + endDate: Date @deprecated(reason: "Use `expiryDate` from `expirySettings` instead.") + + """The gift card tags to remove.""" removeTags: [String!] - """ - The gift card balance amount. - - Added in Saleor 3.1. - """ + """The gift card balance amount.""" balanceAmount: PositiveDecimal } """ Resend a gift card. -Added in Saleor 3.1. - Requires one of the following permissions: MANAGE_GIFT_CARD. Triggers the following webhook events: @@ -27670,8 +26765,6 @@ input GiftCardResendInput @doc(category: "Gift cards") { """ Adds note to the gift card. -Added in Saleor 3.1. - Requires one of the following permissions: MANAGE_GIFT_CARD. Triggers the following webhook events: @@ -27692,9 +26785,7 @@ input GiftCardAddNoteInput @doc(category: "Gift cards") { } """ -Create gift cards. - -Added in Saleor 3.1. +Creates gift cards. Requires one of the following permissions: MANAGE_GIFT_CARD. @@ -27729,9 +26820,7 @@ input GiftCardBulkCreateInput @doc(category: "Gift cards") { } """ -Delete gift cards. - -Added in Saleor 3.1. +Deletes gift cards. Requires one of the following permissions: MANAGE_GIFT_CARD. @@ -27747,8 +26836,6 @@ type GiftCardBulkDelete @doc(category: "Gift cards") @webhookEventsInfo(asyncEve """ Activate gift cards. -Added in Saleor 3.1. - Requires one of the following permissions: MANAGE_GIFT_CARD. Triggers the following webhook events: @@ -27763,8 +26850,6 @@ type GiftCardBulkActivate @doc(category: "Gift cards") @webhookEventsInfo(asyncE """ Deactivate gift cards. -Added in Saleor 3.1. - Requires one of the following permissions: MANAGE_GIFT_CARD. Triggers the following webhook events: @@ -27777,13 +26862,13 @@ type GiftCardBulkDeactivate @doc(category: "Gift cards") @webhookEventsInfo(asyn } """ -Update plugin configuration. +Update plugin configuration. Requires one of the following permissions: MANAGE_PLUGINS. """ type PluginUpdate { plugin: Plugin - pluginsErrors: [PluginError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + pluginsErrors: [PluginError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PluginError!]! } @@ -27800,7 +26885,6 @@ type PluginError { code: PluginErrorCode! } -"""An enumeration.""" enum PluginErrorCode { GRAPHQL_ERROR INVALID @@ -27828,8 +26912,6 @@ input ConfigurationItemInput { """ Trigger sending a notification with the notify plugin method. Serializes nodes provided as ids parameter and includes this data in the notification payload. - -Added in Saleor 3.1. """ type ExternalNotificationTrigger { errors: [ExternalNotificationError!]! @@ -27848,7 +26930,6 @@ type ExternalNotificationError { code: ExternalNotificationErrorCodes! } -"""An enumeration.""" enum ExternalNotificationErrorCodes { REQUIRED INVALID_MODEL_TYPE @@ -27876,10 +26957,6 @@ input ExternalNotificationTriggerInput { """ Creates a new promotion. -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: MANAGE_DISCOUNTS. Triggers the following webhook events: @@ -27919,7 +26996,6 @@ type PromotionCreateError { giftsLimitExceedBy: Int } -"""An enumeration.""" enum PromotionCreateErrorCode { GRAPHQL_ERROR NOT_FOUND @@ -27947,8 +27023,8 @@ input PromotionCreateInput @doc(category: "Discounts") { name: String! """ - Defines the promotion type. Implicate the required promotion rules predicate type and whether the promotion rules will give the catalogue or order discount. - + Defines the promotion type. Implicate the required promotion rules predicate type and whether the promotion rules will give the catalogue or order discount. + Added in Saleor 3.19. """ type: PromotionTypeEnum! @@ -27971,9 +27047,9 @@ input PromotionRuleInput @doc(category: "Discounts") { """ Defines the conditions on the checkout/draft order level that must be met for the reward to be applied. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ orderPredicate: OrderPredicateInput @@ -27990,9 +27066,9 @@ input PromotionRuleInput @doc(category: "Discounts") { """ Defines the reward type of the promotion rule. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ rewardType: RewardTypeEnum @@ -28002,9 +27078,9 @@ input PromotionRuleInput @doc(category: "Discounts") { """ Product variant IDs available as a gift to choose. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ gifts: [ID!] @@ -28058,10 +27134,6 @@ input DiscountedObjectWhereInput @doc(category: "Discounts") { """ Updates an existing promotion. -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: MANAGE_DISCOUNTS. Triggers the following webhook events: @@ -28087,7 +27159,6 @@ type PromotionUpdateError { code: PromotionUpdateErrorCode! } -"""An enumeration.""" enum PromotionUpdateErrorCode { GRAPHQL_ERROR NOT_FOUND @@ -28112,10 +27183,6 @@ input PromotionUpdateInput { """ Deletes a promotion. -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: MANAGE_DISCOUNTS. Triggers the following webhook events: @@ -28139,7 +27206,6 @@ type PromotionDeleteError { code: PromotionDeleteErrorCode! } -"""An enumeration.""" enum PromotionDeleteErrorCode { GRAPHQL_ERROR NOT_FOUND @@ -28148,10 +27214,6 @@ enum PromotionDeleteErrorCode { """ Creates a new promotion rule. -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: MANAGE_DISCOUNTS. Triggers the following webhook events: @@ -28187,7 +27249,6 @@ type PromotionRuleCreateError { giftsLimitExceedBy: Int } -"""An enumeration.""" enum PromotionRuleCreateErrorCode { GRAPHQL_ERROR NOT_FOUND @@ -28215,9 +27276,9 @@ input PromotionRuleCreateInput { """ Defines the conditions on the checkout/draft order level that must be met for the reward to be applied. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ orderPredicate: OrderPredicateInput @@ -28234,9 +27295,9 @@ input PromotionRuleCreateInput { """ Defines the reward type of the promotion rule. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ rewardType: RewardTypeEnum @@ -28246,9 +27307,9 @@ input PromotionRuleCreateInput { """ Product variant IDs available as a gift to choose. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ gifts: [ID!] @@ -28260,10 +27321,6 @@ input PromotionRuleCreateInput { """ Updates an existing promotion rule. -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: MANAGE_DISCOUNTS. Triggers the following webhook events: @@ -28296,7 +27353,6 @@ type PromotionRuleUpdateError { giftsLimitExceedBy: Int } -"""An enumeration.""" enum PromotionRuleUpdateErrorCode { GRAPHQL_ERROR NOT_FOUND @@ -28324,9 +27380,9 @@ input PromotionRuleUpdateInput { """ Defines the conditions on the checkout/draft order level that must be met for the reward to be applied. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ orderPredicate: OrderPredicateInput @@ -28343,9 +27399,9 @@ input PromotionRuleUpdateInput { """ Defines the reward type of the promotion rule. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ rewardType: RewardTypeEnum @@ -28358,18 +27414,18 @@ input PromotionRuleUpdateInput { """ List of variant IDs available as a gift to add. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ addGifts: [ID!] """ List of variant IDs available as a gift to remove. - + Added in Saleor 3.19. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ removeGifts: [ID!] @@ -28378,10 +27434,6 @@ input PromotionRuleUpdateInput { """ Deletes a promotion rule. -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: MANAGE_DISCOUNTS. Triggers the following webhook events: @@ -28405,7 +27457,6 @@ type PromotionRuleDeleteError { code: PromotionRuleDeleteErrorCode! } -"""An enumeration.""" enum PromotionRuleDeleteErrorCode { GRAPHQL_ERROR NOT_FOUND @@ -28414,8 +27465,6 @@ enum PromotionRuleDeleteErrorCode { """ Creates/updates translations for a promotion. -Added in Saleor 3.17. - Requires one of the following permissions: MANAGE_TRANSLATIONS. """ type PromotionTranslate @doc(category: "Discounts") { @@ -28428,7 +27477,7 @@ input PromotionTranslationInput { """ Translated promotion description. - + Rich text format. For reference see https://editorjs.io/ """ description: JSON @@ -28437,8 +27486,6 @@ input PromotionTranslationInput { """ Creates/updates translations for a promotion rule. -Added in Saleor 3.17. - Requires one of the following permissions: MANAGE_TRANSLATIONS. """ type PromotionRuleTranslate @doc(category: "Discounts") { @@ -28451,7 +27498,7 @@ input PromotionRuleTranslationInput { """ Translated promotion description. - + Rich text format. For reference see https://editorjs.io/ """ description: JSON @@ -28460,10 +27507,6 @@ input PromotionRuleTranslationInput { """ Deletes promotions. -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: MANAGE_DISCOUNTS. Triggers the following webhook events: @@ -28495,13 +27538,12 @@ type DiscountError @doc(category: "Discounts") { """ List of voucher codes which causes the error. - + Added in Saleor 3.18. """ voucherCodes: [String!] } -"""An enumeration.""" enum DiscountErrorCode @doc(category: "Discounts") { ALREADY_EXISTS GRAPHQL_ERROR @@ -28517,15 +27559,13 @@ enum DiscountErrorCode @doc(category: "Discounts") { """ Creates a new sale. -DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionCreate` mutation instead. - 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: []) { - discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [DiscountError!]! sale: Sale } @@ -28560,21 +27600,19 @@ input SaleInput @doc(category: "Discounts") { """ Deletes a sale. -DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionDelete` mutation instead. - 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: []) { - discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [DiscountError!]! sale: Sale } """ -Deletes sales. +Deletes sales. Requires one of the following permissions: MANAGE_DISCOUNTS. @@ -28584,15 +27622,13 @@ Triggers the following webhook events: type SaleBulkDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_DELETED], syncEvents: []) { """Returns how many objects were affected.""" count: Int! - discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [DiscountError!]! } """ Updates a sale. -DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionUpdate` mutation instead. - Requires one of the following permissions: MANAGE_DISCOUNTS. Triggers the following webhook events: @@ -28600,7 +27636,7 @@ Triggers the following webhook events: - SALE_TOGGLE (async): Optionally triggered when a sale is started or stopped. """ type SaleUpdate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_UPDATED, SALE_TOGGLE], syncEvents: []) { - discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [DiscountError!]! sale: Sale } @@ -28608,8 +27644,6 @@ type SaleUpdate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SAL """ Adds products, categories, collections to a sale. -DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionRuleCreate` mutation instead. - Requires one of the following permissions: MANAGE_DISCOUNTS. Triggers the following webhook events: @@ -28618,7 +27652,7 @@ Triggers the following webhook events: type SaleAddCatalogues @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_UPDATED], syncEvents: []) { """Sale of which catalogue IDs will be modified.""" sale: Sale - discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [DiscountError!]! } @@ -28632,19 +27666,13 @@ input CatalogueInput @doc(category: "Discounts") { """Collections related to the discount.""" collections: [ID!] - """ - Product variant related to the discount. - - Added in Saleor 3.1. - """ + """Product variant related to the discount.""" variants: [ID!] } """ Removes products, categories, collections from a sale. -DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionRuleUpdate` or `promotionRuleDelete` mutations instead. - Requires one of the following permissions: MANAGE_DISCOUNTS. Triggers the following webhook events: @@ -28653,19 +27681,17 @@ Triggers the following webhook events: type SaleRemoveCatalogues @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [SALE_UPDATED], syncEvents: []) { """Sale of which catalogue IDs will be modified.""" sale: Sale - discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [DiscountError!]! } """ Creates/updates translations for a sale. -DEPRECATED: this mutation will be removed in Saleor 4.0. Use `PromotionTranslate` mutation instead. - Requires one of the following permissions: MANAGE_TRANSLATIONS. """ type SaleTranslate @doc(category: "Discounts") { - translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.") errors: [TranslationError!]! sale: Sale } @@ -28673,14 +27699,12 @@ type SaleTranslate @doc(category: "Discounts") { """ Manage sale's availability in channels. -DEPRECATED: this mutation will be removed in Saleor 4.0. Use `promotionRuleCreate` or `promotionRuleUpdate` mutations instead. - Requires one of the following permissions: MANAGE_DISCOUNTS. """ type SaleChannelListingUpdate @doc(category: "Discounts") { """An updated sale instance.""" sale: Sale - discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [DiscountError!]! } @@ -28701,7 +27725,7 @@ input SaleChannelListingAddInput @doc(category: "Discounts") { } """ -Creates a new voucher. +Creates a new voucher. Requires one of the following permissions: MANAGE_DISCOUNTS. @@ -28710,7 +27734,7 @@ Triggers the following webhook events: - VOUCHER_CODES_CREATED (async): A voucher codes were created. """ type VoucherCreate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_CREATED, VOUCHER_CODES_CREATED], syncEvents: []) { - discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [DiscountError!]! voucher: Voucher } @@ -28722,16 +27746,14 @@ input VoucherInput @doc(category: "Discounts") { """Voucher name.""" name: String - """ - Code to use the voucher. This field will be removed in Saleor 4.0. Use `addCodes` instead. - """ - code: String + """Code to use the voucher.""" + code: String @deprecated(reason: "Use `addCodes` instead.") """ List of codes to add. - + Added in Saleor 3.18. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ addCodes: [String!] @@ -28748,11 +27770,7 @@ input VoucherInput @doc(category: "Discounts") { """Products discounted by the voucher.""" products: [ID!] - """ - Variants discounted by the voucher. - - Added in Saleor 3.1. - """ + """Variants discounted by the voucher.""" variants: [ID!] """Collections discounted by the voucher.""" @@ -28778,11 +27796,11 @@ input VoucherInput @doc(category: "Discounts") { """ When set to 'True', each voucher code can be used only once; otherwise, codes can be used multiple times depending on `usageLimit`. - + The option can only be changed if none of the voucher codes have been used. - + Added in Saleor 3.18. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ singleUse: Boolean @@ -28792,7 +27810,7 @@ input VoucherInput @doc(category: "Discounts") { } """ -Deletes a voucher. +Deletes a voucher. Requires one of the following permissions: MANAGE_DISCOUNTS. @@ -28800,13 +27818,13 @@ Triggers the following webhook events: - VOUCHER_DELETED (async): A voucher was deleted. """ type VoucherDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_DELETED], syncEvents: []) { - discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [DiscountError!]! voucher: Voucher } """ -Deletes vouchers. +Deletes vouchers. Requires one of the following permissions: MANAGE_DISCOUNTS. @@ -28816,12 +27834,12 @@ Triggers the following webhook events: type VoucherBulkDelete @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_DELETED], syncEvents: []) { """Returns how many objects were affected.""" count: Int! - discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [DiscountError!]! } """ -Updates a voucher. +Updates a voucher. Requires one of the following permissions: MANAGE_DISCOUNTS. @@ -28830,13 +27848,13 @@ Triggers the following webhook events: - VOUCHER_CODES_CREATED (async): A voucher code was created. """ type VoucherUpdate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_UPDATED, VOUCHER_CODES_CREATED], syncEvents: []) { - discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [DiscountError!]! voucher: Voucher } """ -Adds products, categories, collections to a voucher. +Adds products, categories, collections to a voucher. Requires one of the following permissions: MANAGE_DISCOUNTS. @@ -28846,12 +27864,12 @@ Triggers the following webhook events: type VoucherAddCatalogues @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_UPDATED], syncEvents: []) { """Voucher of which catalogue IDs will be modified.""" voucher: Voucher - discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [DiscountError!]! } """ -Removes products, categories, collections from a voucher. +Removes products, categories, collections from a voucher. Requires one of the following permissions: MANAGE_DISCOUNTS. @@ -28861,23 +27879,23 @@ Triggers the following webhook events: type VoucherRemoveCatalogues @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_UPDATED], syncEvents: []) { """Voucher of which catalogue IDs will be modified.""" voucher: Voucher - discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [DiscountError!]! } """ -Creates/updates translations for a voucher. +Creates/updates translations for a voucher. Requires one of the following permissions: MANAGE_TRANSLATIONS. """ type VoucherTranslate @doc(category: "Discounts") { - translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.") errors: [TranslationError!]! voucher: Voucher } """ -Manage voucher's availability in channels. +Manage voucher's availability in channels. Requires one of the following permissions: MANAGE_DISCOUNTS. @@ -28887,7 +27905,7 @@ Triggers the following webhook events: type VoucherChannelListingUpdate @doc(category: "Discounts") @webhookEventsInfo(asyncEvents: [VOUCHER_UPDATED], syncEvents: []) { """An updated voucher instance.""" voucher: Voucher - discountErrors: [DiscountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + discountErrors: [DiscountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [DiscountError!]! } @@ -28913,7 +27931,7 @@ input VoucherChannelListingAddInput @doc(category: "Discounts") { """ Deletes voucher codes. -Added in Saleor 3.18. +Added in Saleor 3.18. Requires one of the following permissions: MANAGE_DISCOUNTS. @@ -28942,7 +27960,6 @@ type VoucherCodeBulkDeleteError @doc(category: "Discounts") { voucherCodes: [ID!] } -"""An enumeration.""" enum VoucherCodeBulkDeleteErrorCode @doc(category: "Discounts") { GRAPHQL_ERROR NOT_FOUND @@ -28950,7 +27967,7 @@ enum VoucherCodeBulkDeleteErrorCode @doc(category: "Discounts") { } """ -Export products to csv file. +Export products to csv file. Requires one of the following permissions: MANAGE_PRODUCTS. @@ -28963,7 +27980,7 @@ type ExportProducts @doc(category: "Products") @webhookEventsInfo(asyncEvents: [ The newly created export file job which is responsible for export data. """ exportFile: ExportFile - exportErrors: [ExportError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + exportErrors: [ExportError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ExportError!]! } @@ -28980,7 +27997,6 @@ type ExportError { code: ExportErrorCode! } -"""An enumeration.""" enum ExportErrorCode { GRAPHQL_ERROR INVALID @@ -29045,7 +28061,6 @@ enum ProductFieldEnum @doc(category: "Products") { VARIANT_MEDIA } -"""An enumeration.""" enum FileTypesEnum { CSV XLSX @@ -29054,8 +28069,6 @@ enum FileTypesEnum { """ Export gift cards to csv file. -Added in Saleor 3.1. - Requires one of the following permissions: MANAGE_GIFT_CARD. Triggers the following webhook events: @@ -29089,7 +28102,7 @@ Export voucher codes to csv/xlsx file. Added in Saleor 3.18. -Note: this API is currently in Feature Preview and can be subject to changes at later point. +Note: this API is currently in Feature Preview and can be subject to changes at later point. Requires one of the following permissions: MANAGE_DISCOUNTS. @@ -29118,13 +28131,13 @@ input ExportVoucherCodesInput @doc(category: "Discounts") { } """ -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 +Upload a file. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_STAFF_USER. """ type FileUpload { uploadedFile: File - uploadErrors: [UploadError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + uploadErrors: [UploadError!]! @deprecated(reason: "Use `errors` field instead.") errors: [UploadError!]! } @@ -29141,9 +28154,10 @@ type UploadError { code: UploadErrorCode! } -"""An enumeration.""" enum UploadErrorCode { GRAPHQL_ERROR + INVALID_FILE_TYPE + UNSUPPORTED_MIME_TYPE } """ @@ -29155,7 +28169,7 @@ Triggers the following webhook events: type CheckoutAddPromoCode @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) { """The checkout with the added gift card or voucher.""" checkout: Checkout - checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CheckoutError!]! } @@ -29181,7 +28195,6 @@ type CheckoutError @doc(category: "Checkout") { addressType: AddressTypeEnum } -"""An enumeration.""" enum CheckoutErrorCode @doc(category: "Checkout") { BILLING_ADDRESS_NOT_SET CHECKOUT_NOT_FULLY_PAID @@ -29214,10 +28227,11 @@ enum CheckoutErrorCode @doc(category: "Checkout") { NON_EDITABLE_GIFT_LINE NON_REMOVABLE_GIFT_LINE SHIPPING_CHANGE_FORBIDDEN + MISSING_ADDRESS_DATA } """ -Update billing address in the existing checkout. +Updates billing address in the existing checkout. Triggers the following webhook events: - CHECKOUT_UPDATED (async): A checkout was updated. @@ -29225,7 +28239,7 @@ Triggers the following webhook events: type CheckoutBillingAddressUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) { """An updated checkout.""" checkout: Checkout - checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CheckoutError!]! } @@ -29272,7 +28286,7 @@ type CheckoutComplete @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: """Confirmation data used to process additional authorization steps.""" confirmationData: JSONString - checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CheckoutError!]! } @@ -29288,8 +28302,8 @@ type CheckoutCreate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [ """ Whether the checkout was created or the current active one was returned. Refer to checkoutLinesAdd and checkoutLinesUpdate to merge a cart with an active checkout. """ - created: Boolean @deprecated(reason: "This field will be removed in Saleor 4.0. Always returns `true`.") - checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + created: Boolean @deprecated(reason: "Always returns `true`.") + checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CheckoutError!]! checkout: Checkout } @@ -29306,11 +28320,25 @@ input CheckoutCreateInput @doc(category: "Checkout") { """The customer's email address.""" email: String + """ + Indicates whether the shipping address should be saved to the user’s address book upon checkout completion.Can only be set when a shipping address is provided. If not specified along with the address, the default behavior is to save the address. + + Added in Saleor 3.21. + """ + saveShippingAddress: Boolean + """ The mailing address to where the checkout will be shipped. Note: the address will be ignored if the checkout doesn't contain shippable items. `skipValidation` requires HANDLE_CHECKOUTS and AUTHENTICATED_APP permissions. """ shippingAddress: AddressInput + """ + Indicates whether the billing address should be saved to the user’s address book upon checkout completion. Can only be set when a billing address is provided. If not specified along with the address, the default behavior is to save the address. + + Added in Saleor 3.21. + """ + saveBillingAddress: Boolean + """ Billing address of the customer. `skipValidation` requires HANDLE_CHECKOUTS and AUTHENTICATED_APP permissions. """ @@ -29319,12 +28347,28 @@ input CheckoutCreateInput @doc(category: "Checkout") { """Checkout language code.""" languageCode: LanguageCodeEnum + """The checkout validation rules that can be changed.""" + validationRules: CheckoutValidationRules + """ - The checkout validation rules that can be changed. - - Added in Saleor 3.5. + Checkout public metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + + Added in Saleor 3.21. """ - validationRules: CheckoutValidationRules + metadata: [MetadataInput!] + + """ + Checkout private metadata. Requires one of the following permissions: MANAGE_CHECKOUTS, HANDLE_CHECKOUTS + + Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + + Added in Saleor 3.21. + """ + privateMetadata: [MetadataInput!] } input CheckoutLineInput @doc(category: "Checkout") { @@ -29336,22 +28380,18 @@ input CheckoutLineInput @doc(category: "Checkout") { """ Custom price of the item. Can be set only by apps with `HANDLE_CHECKOUTS` permission. When the line with the same variant will be provided multiple times, the last price will be used. - - Added in Saleor 3.1. """ price: PositiveDecimal """ - Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. - - Added in Saleor 3.6. + Flag that allow force splitting the same variant into multiple lines by skipping the matching logic. """ forceNewLine: Boolean = false """ - Fields required to update the object's metadata. - - Added in Saleor 3.8. + Fields required to update the object's metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] } @@ -29368,13 +28408,7 @@ input CheckoutValidationRules @doc(category: "Checkout") { billingAddress: CheckoutAddressValidationRules } -""" -Create new checkout from existing order. - -Added in Saleor 3.14. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Creates a new checkout from existing order.""" type CheckoutCreateFromOrder @doc(category: "Checkout") { """Variants that were not attached to the checkout.""" unavailableVariants: [CheckoutCreateFromOrderUnavailableVariant!] @@ -29398,7 +28432,6 @@ type CheckoutCreateFromOrderUnavailableVariant @doc(category: "Checkout") { lineId: ID! } -"""An enumeration.""" enum CheckoutCreateFromOrderUnavailableVariantErrorCode @doc(category: "Checkout") { NOT_FOUND PRODUCT_UNAVAILABLE_FOR_PURCHASE @@ -29421,7 +28454,6 @@ type CheckoutCreateFromOrderError @doc(category: "Checkout") { code: CheckoutCreateFromOrderErrorCode! } -"""An enumeration.""" enum CheckoutCreateFromOrderErrorCode @doc(category: "Checkout") { GRAPHQL_ERROR INVALID @@ -29431,7 +28463,7 @@ enum CheckoutCreateFromOrderErrorCode @doc(category: "Checkout") { } """ -Sets the customer as the owner of the checkout. +Sets the customer as the owner of the checkout. Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_USER. @@ -29441,12 +28473,12 @@ Triggers the following webhook events: type CheckoutCustomerAttach @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) { """An updated checkout.""" checkout: Checkout - checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CheckoutError!]! } """ -Removes the user assigned as the owner of the checkout. +Removes the user assigned as the owner of the checkout. Requires one of the following permissions: AUTHENTICATED_APP, AUTHENTICATED_USER. @@ -29456,7 +28488,22 @@ Triggers the following webhook events: type CheckoutCustomerDetach @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) { """An updated checkout.""" checkout: Checkout - checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.") + errors: [CheckoutError!]! +} + +""" +Updates customer note in the existing checkout object. + +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: []) { + """An updated checkout.""" + checkout: Checkout + checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CheckoutError!]! } @@ -29469,7 +28516,7 @@ Triggers the following webhook events: type CheckoutEmailUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) { """An updated checkout.""" checkout: Checkout - checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CheckoutError!]! } @@ -29482,7 +28529,7 @@ Triggers the following webhook events: type CheckoutLineDelete @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) { """An updated checkout.""" checkout: Checkout - checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CheckoutError!]! } @@ -29507,7 +28554,7 @@ Triggers the following webhook events: type CheckoutLinesAdd @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) { """An updated checkout.""" checkout: Checkout - checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CheckoutError!]! } @@ -29520,17 +28567,13 @@ Triggers the following webhook events: type CheckoutLinesUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) { """An updated checkout.""" checkout: Checkout - checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CheckoutError!]! } input CheckoutLineUpdateInput @doc(category: "Checkout") { - """ - ID of the product variant. - - DEPRECATED: this field will be removed in Saleor 4.0. Use `lineId` instead. - """ - variantId: ID + """ID of the product variant.""" + variantId: ID @deprecated(reason: "Use `lineId` instead.") """ The number of items purchased. Optional for apps, required for any other users. @@ -29539,17 +28582,20 @@ input CheckoutLineUpdateInput @doc(category: "Checkout") { """ Custom price of the item. Can be set only by apps with `HANDLE_CHECKOUTS` permission. When the line with the same variant will be provided multiple times, the last price will be used. - - Added in Saleor 3.1. """ price: PositiveDecimal + """ID of the line.""" + lineId: ID + """ - ID of the line. - - Added in Saleor 3.6. + Checkout line public metadata. Will add and update keys. To delete keys use deleteMetadata mutation. + + Added in Saleor 3.21. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ - lineId: ID + metadata: [MetadataInput!] } """ @@ -29561,18 +28607,18 @@ Triggers the following webhook events: type CheckoutRemovePromoCode @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) { """The checkout with the removed gift card or voucher.""" checkout: Checkout - checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CheckoutError!]! } -"""Create a new payment for given checkout.""" +"""Creates a new payment for given checkout.""" type CheckoutPaymentCreate @doc(category: "Checkout") { """Related checkout object.""" checkout: Checkout """A newly created payment.""" payment: Payment - paymentErrors: [PaymentError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + paymentErrors: [PaymentError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PaymentError!]! } @@ -29595,17 +28641,13 @@ input PaymentInput @doc(category: "Payments") { """ returnUrl: String - """ - Payment store type. - - Added in Saleor 3.1. - """ + """Payment store type.""" storePaymentMethod: StorePaymentMethodEnum = NONE """ - User public metadata. - - Added in Saleor 3.1. + User public metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] } @@ -29627,7 +28669,7 @@ enum StorePaymentMethodEnum @doc(category: "Payments") { } """ -Update shipping address in the existing checkout. +Updates shipping address in the existing checkout. Triggers the following webhook events: - CHECKOUT_UPDATED (async): A checkout was updated. @@ -29635,7 +28677,7 @@ Triggers the following webhook events: type CheckoutShippingAddressUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) { """An updated checkout.""" checkout: Checkout - checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CheckoutError!]! } @@ -29649,14 +28691,12 @@ Triggers the following webhook events: type CheckoutShippingMethodUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: [SHIPPING_LIST_METHODS_FOR_CHECKOUT]) { """An updated checkout.""" checkout: Checkout - checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CheckoutError!]! } """ -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. - -Added in Saleor 3.1. +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. Triggers the following webhook events: - SHIPPING_LIST_METHODS_FOR_CHECKOUT (sync): Triggered when updating the checkout delivery method with the external one. @@ -29669,7 +28709,7 @@ type CheckoutDeliveryMethodUpdate @doc(category: "Checkout") @webhookEventsInfo( } """ -Update language code in the existing checkout. +Updates language code in the existing checkout. Triggers the following webhook events: - CHECKOUT_UPDATED (async): A checkout was updated. @@ -29677,15 +28717,13 @@ Triggers the following webhook events: type CheckoutLanguageCodeUpdate @doc(category: "Checkout") @webhookEventsInfo(asyncEvents: [CHECKOUT_UPDATED], syncEvents: []) { """An updated checkout.""" checkout: Checkout - checkoutErrors: [CheckoutError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + checkoutErrors: [CheckoutError!]! @deprecated(reason: "Use `errors` field instead.") errors: [CheckoutError!]! } """ Create new order from existing checkout. Requires the following permissions: AUTHENTICATED_APP and HANDLE_CHECKOUTS. -Added in Saleor 3.2. - 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. @@ -29723,7 +28761,6 @@ type OrderCreateFromCheckoutError @doc(category: "Orders") { lines: [ID!] } -"""An enumeration.""" enum OrderCreateFromCheckoutErrorCode @doc(category: "Orders") { GRAPHQL_ERROR CHECKOUT_NOT_FOUND @@ -29742,7 +28779,7 @@ enum OrderCreateFromCheckoutErrorCode @doc(category: "Orders") { } """ -Creates new channel. +Creates a new channel. Requires one of the following permissions: MANAGE_CHANNELS. @@ -29750,7 +28787,7 @@ Triggers the following webhook events: - CHANNEL_CREATED (async): A channel was created. """ type ChannelCreate @doc(category: "Channels") @webhookEventsInfo(asyncEvents: [CHANNEL_CREATED], syncEvents: []) { - channelErrors: [ChannelError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + channelErrors: [ChannelError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ChannelError!]! channel: Channel } @@ -29774,7 +28811,6 @@ type ChannelError @doc(category: "Channels") { warehouses: [ID!] } -"""An enumeration.""" enum ChannelErrorCode @doc(category: "Channels") { ALREADY_EXISTS GRAPHQL_ERROR @@ -29791,60 +28827,36 @@ input ChannelCreateInput @doc(category: "Channels") { """Determine if channel will be set active or not.""" isActive: Boolean - """ - The channel stock settings. - - Added in Saleor 3.7. - """ + """The channel stock settings.""" stockSettings: StockSettingsInput """List of shipping zones to assign to the channel.""" addShippingZones: [ID!] - """ - List of warehouses to assign to the channel. - - Added in Saleor 3.5. - """ + """List of warehouses to assign to the channel.""" addWarehouses: [ID!] - """ - The channel order settings - - Added in Saleor 3.12. - """ + """The channel order settings""" orderSettings: OrderSettingsInput """ - Channel public metadata. - - Added in Saleor 3.15. + Channel public metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Channel private metadata. - - Added in Saleor 3.15. + Channel private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] - """ - The channel checkout settings - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """The channel checkout settings""" checkoutSettings: CheckoutSettingsInput - """ - The channel payment settings - - Added in Saleor 3.16. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """The channel payment settings""" paymentSettings: PaymentSettingsInput """Name of the channel.""" @@ -29858,8 +28870,6 @@ input ChannelCreateInput @doc(category: "Channels") { """ Default country for the channel. Default country can be used in checkout to determine the stock quantities or calculate taxes when the country was not explicitly provided. - - Added in Saleor 3.1. """ defaultCountry: CountryCode! } @@ -29884,19 +28894,11 @@ input OrderSettingsInput @doc(category: "Orders") { """ Expiration time in minutes. Default null - means do not expire any orders. Enter 0 or null to disable. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ expireOrdersAfter: Minute """ The time in days after expired orders will be deleted.Allowed range is from 1 to 120. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ deleteExpiredOrdersAfter: Day @@ -29904,54 +28906,109 @@ input OrderSettingsInput @doc(category: "Orders") { Determine what strategy will be used to mark the order as paid. Based on the chosen option, the proper object will be created and attached to the order when it's manually marked as paid. `PAYMENT_FLOW` - [default option] creates the `Payment` object. `TRANSACTION_FLOW` - creates the `TransactionItem` object. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ markAsPaidStrategy: MarkAsPaidStrategyEnum """ Determine if it is possible to place unpaid order by calling `checkoutComplete` mutation. - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ allowUnpaidOrders: Boolean """ Specify whether a coupon applied to draft orders will count toward voucher usage. - + Warning: when switching this setting from `false` to `true`, the vouchers will be disconnected from all draft orders. - + Added in Saleor 3.18. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ includeDraftOrderInVoucherUsage: Boolean + + """ + Time in hours after which the draft order line price will be refreshed. Default value is 24 hours. Enter 0 or null to disable. + + Added in Saleor 3.21. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + draftOrderLinePriceFreezePeriod: Hour + + """ + 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. + """ + useLegacyLineDiscountPropagation: Boolean } input CheckoutSettingsInput @doc(category: "Checkout") { """ - 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. - - Added in Saleor 3.15. - - DEPRECATED: this field will be removed in Saleor 4.0. + 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 @deprecated + + """ + 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. + """ + automaticallyCompleteFullyPaidCheckouts: Boolean @deprecated(reason: "Use `automatic_completion` instead.") + + """ + Settings for automatic completion of fully paid checkouts. + + Added in Saleor 3.22. + """ + automaticCompletion: CheckoutAutoCompleteInput +} + +input CheckoutAutoCompleteInput @doc(category: "Checkout") { + """ + 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. + """ + enabled: Boolean! + + """ + The time in minutes after which the fully paid checkout will be automatically completed. Default is 30. Set to 0 for immediate completion. Should be less than the threshold for the oldest modified checkout eligible for automatic completion. """ - useLegacyErrorFlow: Boolean + delay: Minute + + """ + Specifies the earliest date on which fully paid checkouts can begin to be automatically completed. Fully paid checkouts dated before this cut-off will not be automatically completed. Must be less than the threshold of the oldest modified checkout eligible for automatic completion. Default is current date time. + """ + cutOffDate: DateTime } input PaymentSettingsInput @doc(category: "Payments") { """ Determine the transaction flow strategy to be used. Include the selected option in the payload sent to the payment app, as a requested action for the transaction. - - Added in Saleor 3.16. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ defaultTransactionFlowStrategy: TransactionFlowStrategyEnum + + """ + Determine if the funds for expired checkouts should be released automatically. + + Added in Saleor 3.20. + """ + releaseFundsForExpiredCheckouts: Boolean + + """ + The time in hours after which funds for expired checkouts will be released. + + Added in Saleor 3.20. + """ + checkoutTtlBeforeReleasingFunds: Hour + + """ + 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 } """ @@ -29967,7 +29024,7 @@ Triggers the following webhook events: - 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: []) { - channelErrors: [ChannelError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + channelErrors: [ChannelError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ChannelError!]! channel: Channel } @@ -29976,60 +29033,36 @@ input ChannelUpdateInput @doc(category: "Channels") { """Determine if channel will be set active or not.""" isActive: Boolean - """ - The channel stock settings. - - Added in Saleor 3.7. - """ + """The channel stock settings.""" stockSettings: StockSettingsInput """List of shipping zones to assign to the channel.""" addShippingZones: [ID!] - """ - List of warehouses to assign to the channel. - - Added in Saleor 3.5. - """ + """List of warehouses to assign to the channel.""" addWarehouses: [ID!] - """ - The channel order settings - - Added in Saleor 3.12. - """ + """The channel order settings""" orderSettings: OrderSettingsInput """ - Channel public metadata. - - Added in Saleor 3.15. + Channel public metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Channel private metadata. - - Added in Saleor 3.15. + Channel private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] - """ - The channel checkout settings - - Added in Saleor 3.15. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """The channel checkout settings""" checkoutSettings: CheckoutSettingsInput - """ - The channel payment settings - - Added in Saleor 3.16. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """The channel payment settings""" paymentSettings: PaymentSettingsInput """Name of the channel.""" @@ -30040,24 +29073,18 @@ input ChannelUpdateInput @doc(category: "Channels") { """ Default country for the channel. Default country can be used in checkout to determine the stock quantities or calculate taxes when the country was not explicitly provided. - - Added in Saleor 3.1. """ defaultCountry: CountryCode """List of shipping zones to unassign from the channel.""" removeShippingZones: [ID!] - """ - List of warehouses to unassign from the channel. - - Added in Saleor 3.5. - """ + """List of warehouses to unassign from the channel.""" removeWarehouses: [ID!] } """ -Delete a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. +Deletes a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. Requires one of the following permissions: MANAGE_CHANNELS. @@ -30065,18 +29092,20 @@ Triggers the following webhook events: - CHANNEL_DELETED (async): A channel was deleted. """ type ChannelDelete @doc(category: "Channels") @webhookEventsInfo(asyncEvents: [CHANNEL_DELETED], syncEvents: []) { - channelErrors: [ChannelError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + channelErrors: [ChannelError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ChannelError!]! channel: Channel } input ChannelDeleteInput @doc(category: "Channels") { - """ID of channel to migrate orders from origin channel.""" + """ + ID of a channel to migrate orders from the origin channel. Target channel has to have the same currency as the origin. + """ channelId: ID! } """ -Activate a channel. +Activate a channel. Requires one of the following permissions: MANAGE_CHANNELS. @@ -30086,12 +29115,12 @@ Triggers the following webhook events: type ChannelActivate @doc(category: "Channels") @webhookEventsInfo(asyncEvents: [CHANNEL_STATUS_CHANGED], syncEvents: []) { """Activated channel.""" channel: Channel - channelErrors: [ChannelError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + channelErrors: [ChannelError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ChannelError!]! } """ -Deactivate a channel. +Deactivate a channel. Requires one of the following permissions: MANAGE_CHANNELS. @@ -30101,15 +29130,13 @@ Triggers the following webhook events: type ChannelDeactivate @doc(category: "Channels") @webhookEventsInfo(asyncEvents: [CHANNEL_STATUS_CHANGED], syncEvents: []) { """Deactivated channel.""" channel: Channel - channelErrors: [ChannelError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + channelErrors: [ChannelError!]! @deprecated(reason: "Use `errors` field instead.") errors: [ChannelError!]! } """ Reorder the warehouses of a channel. -Added in Saleor 3.7. - Requires one of the following permissions: MANAGE_CHANNELS. """ type ChannelReorderWarehouses @doc(category: "Channels") { @@ -30125,8 +29152,9 @@ Triggers the following webhook events: - ATTRIBUTE_CREATED (async): An attribute was created. """ type AttributeCreate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_CREATED], syncEvents: []) { + """The created attribute.""" attribute: Attribute - attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + attributeErrors: [AttributeError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AttributeError!]! } @@ -30143,7 +29171,6 @@ type AttributeError @doc(category: "Attributes") { code: AttributeErrorCode! } -"""An enumeration.""" enum AttributeErrorCode @doc(category: "Attributes") { ALREADY_EXISTS GRAPHQL_ERROR @@ -30189,36 +29216,31 @@ 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. - - DEPRECATED: this field will be removed in Saleor 4.0. - """ - filterableInStorefront: Boolean + """Whether the attribute can be filtered in storefront.""" + filterableInStorefront: Boolean @deprecated """Whether the attribute can be filtered in dashboard.""" filterableInDashboard: Boolean """ The position of the attribute in the storefront navigation (0 by default). - - DEPRECATED: this field will be removed in Saleor 4.0. """ - storefrontSearchPosition: Int + storefrontSearchPosition: Int @deprecated - """ - Whether the attribute can be displayed in the admin product list. - - DEPRECATED: this field will be removed in Saleor 4.0. - """ - availableInGrid: Boolean + """Whether the attribute can be displayed in the admin product list.""" + availableInGrid: Boolean @deprecated + + """External ID of this attribute.""" + externalReference: String """ - External ID of this attribute. - - Added in Saleor 3.10. + Specifies reference types to narrow down the choices of reference objects. Applicable only for `REFERENCE` and `SINGLE_REFERENCE` attributes with `PRODUCT`, `PRODUCT_VARIANT` and `PAGE` entity types. Accepts `ProductType` IDs for `PRODUCT` and `PRODUCT_VARIANT` entity types, and `PageType` IDs for `PAGE` entity type. If omitted, all objects of the selected entity type are available as attribute values. + + A maximum of 100 reference types can be specified. + + Added in Saleor 3.22. """ - externalReference: String + referenceTypes: [ID!] } input AttributeValueCreateInput @doc(category: "Attributes") { @@ -30229,19 +29251,15 @@ 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 in Saleor 4.0.The rich text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute. """ - richText: JSONString + 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.") """ Represents the text of the attribute value, plain text without formatting. - - DEPRECATED: this field will be removed in Saleor 4.0.The plain text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute. """ - plainText: String + 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.") """URL of the file attribute. Every time, a new value is created.""" fileUrl: String @@ -30249,11 +29267,7 @@ input AttributeValueCreateInput @doc(category: "Attributes") { """File content type.""" contentType: String - """ - External ID of this attribute value. - - Added in Saleor 3.10. - """ + """External ID of this attribute value.""" externalReference: String """Name of a value displayed in the interface.""" @@ -30261,7 +29275,7 @@ input AttributeValueCreateInput @doc(category: "Attributes") { } """ -Deletes an attribute. +Deletes an attribute. Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. @@ -30269,13 +29283,13 @@ Triggers the following webhook events: - ATTRIBUTE_DELETED (async): An attribute was deleted. """ type AttributeDelete @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_DELETED], syncEvents: []) { - attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + attributeErrors: [AttributeError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AttributeError!]! attribute: Attribute } """ -Updates attribute. +Updates attribute. Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. @@ -30283,8 +29297,9 @@ Triggers the following webhook events: - ATTRIBUTE_UPDATED (async): An attribute was updated. """ type AttributeUpdate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_UPDATED], syncEvents: []) { + """The updated attribute.""" attribute: Attribute - attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + attributeErrors: [AttributeError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AttributeError!]! } @@ -30318,36 +29333,31 @@ 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. - - DEPRECATED: this field will be removed in Saleor 4.0. - """ - filterableInStorefront: Boolean + """Whether the attribute can be filtered in storefront.""" + filterableInStorefront: Boolean @deprecated """Whether the attribute can be filtered in dashboard.""" filterableInDashboard: Boolean """ The position of the attribute in the storefront navigation (0 by default). - - DEPRECATED: this field will be removed in Saleor 4.0. """ - storefrontSearchPosition: Int + storefrontSearchPosition: Int @deprecated - """ - Whether the attribute can be displayed in the admin product list. - - DEPRECATED: this field will be removed in Saleor 4.0. - """ - availableInGrid: Boolean + """Whether the attribute can be displayed in the admin product list.""" + availableInGrid: Boolean @deprecated + + """External ID of this product.""" + externalReference: String """ - External ID of this product. - - Added in Saleor 3.10. + Specifies reference types to narrow down the choices of reference objects. Applicable only for `REFERENCE` and `SINGLE_REFERENCE` attributes with `PRODUCT`, `PRODUCT_VARIANT` and `PAGE` entity types. Accepts `ProductType` IDs for `PRODUCT` and `PRODUCT_VARIANT` entity types, and `PageType` IDs for `PAGE` entity type. If omitted, all objects of the selected entity type are available as attribute values. + + A maximum of 100 reference types can be specified. + + Added in Saleor 3.22. """ - externalReference: String + referenceTypes: [ID!] } input AttributeValueUpdateInput @doc(category: "Attributes") { @@ -30358,19 +29368,15 @@ 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 in Saleor 4.0.The rich text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute. """ - richText: JSONString + 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.") """ Represents the text of the attribute value, plain text without formatting. - - DEPRECATED: this field will be removed in Saleor 4.0.The plain text attribute hasn't got predefined value, so can be specified only from instance that supports the given attribute. """ - plainText: String + 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.") """URL of the file attribute. Every time, a new value is created.""" fileUrl: String @@ -30378,11 +29384,7 @@ input AttributeValueUpdateInput @doc(category: "Attributes") { """File content type.""" contentType: String - """ - External ID of this attribute value. - - Added in Saleor 3.10. - """ + """External ID of this attribute value.""" externalReference: String """Name of a value displayed in the interface.""" @@ -30392,10 +29394,6 @@ input AttributeValueUpdateInput @doc(category: "Attributes") { """ Creates attributes. -Added in Saleor 3.15. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Triggers the following webhook events: - ATTRIBUTE_CREATED (async): An attribute was created. """ @@ -30429,7 +29427,6 @@ type AttributeBulkCreateError @doc(category: "Attributes") { code: AttributeBulkCreateErrorCode! } -"""An enumeration.""" enum AttributeBulkCreateErrorCode @doc(category: "Attributes") { ALREADY_EXISTS BLANK @@ -30445,10 +29442,6 @@ enum AttributeBulkCreateErrorCode @doc(category: "Attributes") { """ Updates attributes. -Added in Saleor 3.15. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Triggers the following webhook events: - ATTRIBUTE_UPDATED (async): An attribute was updated. Optionally called when new attribute value was created or deleted. - ATTRIBUTE_VALUE_CREATED (async): Called optionally when an attribute value was created. @@ -30484,8 +29477,7 @@ type AttributeBulkUpdateError @doc(category: "Attributes") { code: AttributeBulkUpdateErrorCode! } -"""An enumeration.""" -enum AttributeBulkUpdateErrorCode { +enum AttributeBulkUpdateErrorCode @doc(category: "Attributes") { ALREADY_EXISTS BLANK GRAPHQL_ERROR @@ -30509,12 +29501,12 @@ input AttributeBulkUpdateInput @doc(category: "Attributes") { } """ -Creates/updates translations for an attribute. +Creates/updates translations for an attribute. Requires one of the following permissions: MANAGE_TRANSLATIONS. """ type AttributeTranslate @doc(category: "Attributes") { - translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.") errors: [TranslationError!]! attribute: Attribute } @@ -30522,10 +29514,6 @@ type AttributeTranslate @doc(category: "Attributes") { """ Creates/updates translations for attributes. -Added in Saleor 3.14. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: MANAGE_TRANSLATIONS. """ type AttributeBulkTranslate @doc(category: "Attributes") { @@ -30558,7 +29546,6 @@ type AttributeBulkTranslateError { code: AttributeTranslateErrorCode! } -"""An enumeration.""" enum AttributeTranslateErrorCode @doc(category: "Attributes") { GRAPHQL_ERROR INVALID @@ -30581,7 +29568,7 @@ input AttributeBulkTranslateInput @doc(category: "Attributes") { } """ -Deletes attributes. +Deletes attributes. Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. @@ -30591,12 +29578,12 @@ Triggers the following webhook events: type AttributeBulkDelete @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_DELETED], syncEvents: []) { """Returns how many objects were affected.""" count: Int! - attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + attributeErrors: [AttributeError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AttributeError!]! } """ -Deletes values of attributes. +Deletes values of attributes. Requires one of the following permissions: MANAGE_PAGE_TYPES_AND_ATTRIBUTES. @@ -30607,12 +29594,12 @@ Triggers the following webhook events: type AttributeValueBulkDelete @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_DELETED, ATTRIBUTE_UPDATED], syncEvents: []) { """Returns how many objects were affected.""" count: Int! - attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + attributeErrors: [AttributeError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AttributeError!]! } """ -Creates a value for an attribute. +Creates a value for an attribute. Requires one of the following permissions: MANAGE_PRODUCTS. @@ -30623,13 +29610,13 @@ Triggers the following webhook events: type AttributeValueCreate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_CREATED, ATTRIBUTE_UPDATED], syncEvents: []) { """The updated attribute.""" attribute: Attribute - attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + attributeErrors: [AttributeError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AttributeError!]! attributeValue: AttributeValue } """ -Deletes a value of an attribute. +Deletes a value of an attribute. Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. @@ -30640,13 +29627,13 @@ Triggers the following webhook events: type AttributeValueDelete @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_DELETED, ATTRIBUTE_UPDATED], syncEvents: []) { """The updated attribute.""" attribute: Attribute - attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + attributeErrors: [AttributeError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AttributeError!]! attributeValue: AttributeValue } """ -Updates value of an attribute. +Updates value of an attribute. Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. @@ -30657,17 +29644,13 @@ Triggers the following webhook events: type AttributeValueUpdate @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_UPDATED, ATTRIBUTE_UPDATED], syncEvents: []) { """The updated attribute.""" attribute: Attribute - attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + attributeErrors: [AttributeError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AttributeError!]! attributeValue: AttributeValue } """ -Creates/updates translations for attributes values. - -Added in Saleor 3.14. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. +Creates/updates translations for attribute values. Requires one of the following permissions: MANAGE_TRANSLATIONS. """ @@ -30701,7 +29684,6 @@ type AttributeValueBulkTranslateError { code: AttributeValueTranslateErrorCode! } -"""An enumeration.""" enum AttributeValueTranslateErrorCode @doc(category: "Attributes") { GRAPHQL_ERROR INVALID @@ -30728,7 +29710,7 @@ input AttributeValueTranslationInput { """ Translated text. - + Rich text format. For reference see https://editorjs.io/ """ richText: JSONString @@ -30738,18 +29720,18 @@ input AttributeValueTranslationInput { } """ -Creates/updates translations for an attribute value. +Creates/updates translations for an attribute value. Requires one of the following permissions: MANAGE_TRANSLATIONS. """ type AttributeValueTranslate @doc(category: "Attributes") { - translationErrors: [TranslationError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + translationErrors: [TranslationError!]! @deprecated(reason: "Use `errors` field instead.") errors: [TranslationError!]! attributeValue: AttributeValue } """ -Reorder the values of an attribute. +Reorder the values of an attribute. Requires one of the following permissions: MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES. @@ -30760,7 +29742,7 @@ Triggers the following webhook events: type AttributeReorderValues @doc(category: "Attributes") @webhookEventsInfo(asyncEvents: [ATTRIBUTE_VALUE_UPDATED, ATTRIBUTE_UPDATED], syncEvents: []) { """Attribute from which values are reordered.""" attribute: Attribute - attributeErrors: [AttributeError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + attributeErrors: [AttributeError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AttributeError!]! } @@ -30773,7 +29755,7 @@ Triggers the following webhook events: type AppCreate @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_INSTALLED], syncEvents: []) { """The newly created authentication token.""" authToken: String - appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AppError!]! app: App } @@ -30794,7 +29776,6 @@ type AppError @doc(category: "Apps") { permissions: [PermissionEnum!] } -"""An enumeration.""" enum AppErrorCode @doc(category: "Apps") { FORBIDDEN GRAPHQL_ERROR @@ -30819,7 +29800,7 @@ input AppInput @doc(category: "Apps") { """ Canonical app ID. If not provided, the identifier will be generated based on app.id. - + Added in Saleor 3.19. """ identifier: String @@ -30829,7 +29810,7 @@ input AppInput @doc(category: "Apps") { } """ -Updates an existing app. +Updates an existing app. Requires one of the following permissions: MANAGE_APPS. @@ -30837,13 +29818,13 @@ Triggers the following webhook events: - APP_UPDATED (async): An app was updated. """ type AppUpdate @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_UPDATED], syncEvents: []) { - appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AppError!]! app: App } """ -Deletes an app. +Deletes an app. Requires one of the following permissions: MANAGE_APPS. @@ -30851,20 +29832,20 @@ Triggers the following webhook events: - APP_DELETED (async): An app was deleted. """ type AppDelete @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_DELETED], syncEvents: []) { - appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AppError!]! app: App } """ -Creates a new token. +Creates a new token. Requires one of the following permissions: MANAGE_APPS. """ type AppTokenCreate @doc(category: "Apps") { """The newly created authentication token.""" authToken: String - appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AppError!]! appToken: AppToken } @@ -30878,12 +29859,12 @@ input AppTokenInput @doc(category: "Apps") { } """ -Deletes an authentication token assigned to app. +Deletes an authentication token assigned to app. Requires one of the following permissions: MANAGE_APPS. """ type AppTokenDelete @doc(category: "Apps") { - appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AppError!]! appToken: AppToken } @@ -30892,7 +29873,7 @@ type AppTokenDelete @doc(category: "Apps") { type AppTokenVerify @doc(category: "Apps") { """Determine if token is valid or not.""" valid: Boolean! - appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AppError!]! } @@ -30900,7 +29881,7 @@ 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") { - appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AppError!]! appInstallation: AppInstallation } @@ -30920,7 +29901,7 @@ input AppInstallInput @doc(category: "Apps") { } """ -Retry failed installation of new app. +Retry failed installation of new app. Requires one of the following permissions: MANAGE_APPS. @@ -30928,31 +29909,31 @@ Triggers the following webhook events: - APP_INSTALLED (async): An app was installed. """ type AppRetryInstall @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_INSTALLED], syncEvents: []) { - appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AppError!]! appInstallation: AppInstallation } """ -Delete failed installation. +Deletes failed installation. Requires one of the following permissions: MANAGE_APPS. """ type AppDeleteFailedInstallation @doc(category: "Apps") { - appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AppError!]! appInstallation: AppInstallation } """ -Fetch and validate manifest. +Fetch and validate manifest. Requires one of the following permissions: MANAGE_APPS. """ type AppFetchManifest @doc(category: "Apps") { """The validated manifest.""" manifest: Manifest - appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AppError!]! } @@ -30977,15 +29958,15 @@ type Manifest @doc(category: "Apps") { appUrl: String """URL to iframe with the configuration for the app.""" - configurationUrl: String @deprecated(reason: "This field will be removed in Saleor 4.0. Use `appUrl` instead.") + configurationUrl: String @deprecated(reason: "Use `appUrl` instead.") """ - Endpoint used during process of app installation, [see installing an app.](https://docs.saleor.io/docs/3.x/developer/extending/apps/installing-apps#installing-an-app) + Endpoint used during process of app installation, [see installing an app.](https://docs.saleor.io/developer/extending/apps/installing-apps#installing-an-app) """ tokenTargetUrl: String """Description of the data privacy defined for this app.""" - dataPrivacy: String @deprecated(reason: "This field will be removed in Saleor 4.0. Use `dataPrivacyUrl` instead.") + dataPrivacy: String @deprecated(reason: "Use `dataPrivacyUrl` instead.") """URL to the full privacy policy.""" dataPrivacyUrl: String @@ -30997,49 +29978,23 @@ type Manifest @doc(category: "Apps") { supportUrl: String """ - List of extensions that will be mounted in Saleor's dashboard. For details, please [see the extension section.](https://docs.saleor.io/docs/3.x/developer/extending/apps/extending-dashboard-with-apps#key-concepts) + List of extensions that will be mounted in Saleor's dashboard. For details, please [see the extension section.](https://docs.saleor.io/developer/extending/apps/extending-dashboard-with-apps#key-concepts) """ extensions: [AppManifestExtension!]! - """ - List of the app's webhooks. - - Added in Saleor 3.5. - """ + """List of the app's webhooks.""" webhooks: [AppManifestWebhook!]! - """ - The audience that will be included in all JWT tokens for the app. - - Added in Saleor 3.8. - """ + """The audience that will be included in all JWT tokens for the app.""" audience: String - """ - Determines the app's required Saleor version as semver range. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Determines the app's required Saleor version as semver range.""" requiredSaleorVersion: AppManifestRequiredSaleorVersion - """ - The App's author name. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """The App's author name.""" author: String - """ - App's brand data. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """App's brand data.""" brand: AppManifestBrand } @@ -31054,10 +30009,31 @@ type AppManifestExtension @doc(category: "Apps") { url: String! """Place where given extension will be mounted.""" - mount: AppExtensionMountEnum! + mount: AppExtensionMountEnum! @deprecated(reason: "Use `mountName` instead.") """Type of way how app extension will be opened.""" - target: AppExtensionTargetEnum! + target: AppExtensionTargetEnum! @deprecated(reason: "Use `targetName` instead.") + + """ + Name of the extension mount point in the dashboard. Replaces `mount` + + Added in Saleor 3.22. + """ + mountName: String! + + """ + Name of the extension target in the dashboard. Replaces `target` + + Added in Saleor 3.22. + """ + targetName: String! + + """ + JSON object with settings for this extension. + + Added in Saleor 3.22. + """ + settings: JSON! } type AppManifestWebhook @doc(category: "Apps") { @@ -31078,58 +30054,22 @@ type AppManifestWebhook @doc(category: "Apps") { } type AppManifestRequiredSaleorVersion @doc(category: "Apps") { - """ - Required Saleor version as semver range. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Required Saleor version as semver range.""" constraint: String! - """ - Informs if the Saleor version matches the required one. - - Added in Saleor 3.13. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Informs if the Saleor version matches the required one.""" satisfied: Boolean! } -""" -Represents the app's manifest brand data. - -Added in Saleor 3.14. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Represents the app's manifest brand data.""" type AppManifestBrand @doc(category: "Apps") { - """ - App's logos details. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """App's logos details.""" logo: AppManifestBrandLogo! } -""" -Represents the app's manifest brand data. - -Added in Saleor 3.14. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Represents the app's manifest brand data.""" type AppManifestBrandLogo @doc(category: "Apps") { - """ - Data URL with a base64 encoded logo image. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Data URL with a base64 encoded 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). @@ -31138,17 +30078,13 @@ type AppManifestBrandLogo @doc(category: "Apps") { """ The format of the image. When not provided, format of the original image will be used. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ format: IconThumbnailFormatEnum = ORIGINAL ): String! } """ -Activate the app. +Activate the app. Requires one of the following permissions: MANAGE_APPS. @@ -31156,13 +30092,13 @@ Triggers the following webhook events: - APP_STATUS_CHANGED (async): An app was activated. """ type AppActivate @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_STATUS_CHANGED], syncEvents: []) { - appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AppError!]! app: App } """ -Deactivate the app. +Deactivate the app. Requires one of the following permissions: MANAGE_APPS. @@ -31170,11 +30106,25 @@ Triggers the following webhook events: - APP_STATUS_CHANGED (async): An app was deactivated. """ type AppDeactivate @doc(category: "Apps") @webhookEventsInfo(asyncEvents: [APP_STATUS_CHANGED], syncEvents: []) { - appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AppError!]! app: App } +""" +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. + +Requires one of the following permissions: MANAGE_APPS. +""" +type AppReenableSyncWebhooks @doc(category: "Apps") { + """App for which sync webhooks were re-enabled.""" + app: App + appErrors: [AppError!]! @deprecated(reason: "Use `errors` field instead.") + errors: [AppError!]! +} + """Create JWT token.""" type CreateToken @doc(category: "Authentication") { """JWT token, required to authenticate.""" @@ -31188,7 +30138,7 @@ type CreateToken @doc(category: "Authentication") { """A user instance.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } @@ -31209,7 +30159,6 @@ type AccountError @doc(category: "Users") { addressType: AddressTypeEnum } -"""An enumeration.""" enum AccountErrorCode @doc(category: "Users") { ACTIVATE_OWN_ACCOUNT ACTIVATE_SUPERUSER_ACCOUNT @@ -31258,7 +30207,7 @@ type RefreshToken @doc(category: "Authentication") { """A user instance.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } @@ -31272,7 +30221,7 @@ type VerifyToken @doc(category: "Authentication") { """JWT payload.""" payload: GenericScalar - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } @@ -31284,12 +30233,12 @@ String, Boolean, Int, Float, List or Object. scalar GenericScalar """ -Deactivate all JWT tokens of the currently authenticated user. +Deactivate all JWT tokens of the currently authenticated user. Requires one of the following permissions: AUTHENTICATED_USER. """ type DeactivateAllUserTokens @doc(category: "Authentication") { - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } @@ -31297,7 +30246,7 @@ type DeactivateAllUserTokens @doc(category: "Authentication") { type ExternalAuthenticationUrl @doc(category: "Authentication") { """The data returned by authentication plugin.""" authenticationData: JSONString - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } @@ -31314,7 +30263,7 @@ type ExternalObtainAccessTokens @doc(category: "Authentication") { """A user instance.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } @@ -31331,7 +30280,7 @@ type ExternalRefresh @doc(category: "Authentication") { """A user instance.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } @@ -31339,7 +30288,7 @@ type ExternalRefresh @doc(category: "Authentication") { type ExternalLogout @doc(category: "Authentication") { """The data returned by authentication plugin.""" logoutData: JSONString - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } @@ -31353,7 +30302,7 @@ type ExternalVerify @doc(category: "Authentication") { """External data.""" verifyData: JSONString - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } @@ -31366,17 +30315,13 @@ Triggers the following webhook events: - 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: []) { - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } """ Sends a notification confirmation. -Added in Saleor 3.15. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: AUTHENTICATED_USER. Triggers the following webhook events: @@ -31400,7 +30345,6 @@ type SendConfirmationEmailError @doc(category: "Users") { code: SendConfirmationEmailErrorCode! } -"""An enumeration.""" enum SendConfirmationEmailErrorCode @doc(category: "Users") { INVALID ACCOUNT_CONFIRMED @@ -31417,7 +30361,7 @@ Triggers the following webhook events: type ConfirmAccount @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ACCOUNT_CONFIRMED], syncEvents: []) { """An activated user account.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } @@ -31436,24 +30380,24 @@ type SetPassword @doc(category: "Users") { """A user instance.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } """ -Change the password of the logged in user. +Change the password of the logged in user. Requires one of the following permissions: AUTHENTICATED_USER. """ type PasswordChange @doc(category: "Users") { """A user instance with a new password.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } """ -Request email change of the logged in user. +Request email change of the logged in user. Requires one of the following permissions: AUTHENTICATED_USER. @@ -31464,12 +30408,12 @@ Triggers the following webhook events: type RequestEmailChange @doc(category: "Users") @webhookEventsInfo(asyncEvents: [NOTIFY_USER, ACCOUNT_CHANGE_EMAIL_REQUESTED], syncEvents: []) { """A user instance.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } """ -Confirm the email change of the logged-in user. +Confirm the email change of the logged-in user. Requires one of the following permissions: AUTHENTICATED_USER. @@ -31481,7 +30425,7 @@ Triggers the following webhook events: type ConfirmEmailChange @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED, NOTIFY_USER, ACCOUNT_EMAIL_CHANGED], syncEvents: []) { """A user instance with a new email.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } @@ -31497,7 +30441,7 @@ Triggers the following webhook events: type AccountAddressCreate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED, ADDRESS_CREATED], syncEvents: []) { """A user instance for which the address was created.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! address: Address } @@ -31511,13 +30455,13 @@ Triggers the following webhook events: type AccountAddressUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_UPDATED], syncEvents: []) { """A user object for which the address was edited.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! address: Address } """ -Delete an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER. +Deletes an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER. Triggers the following webhook events: - ADDRESS_DELETED (async): An address was deleted. @@ -31525,13 +30469,13 @@ Triggers the following webhook events: type AccountAddressDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_DELETED], syncEvents: []) { """A user instance for which the address was deleted.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! address: Address } """ -Sets a default address for the authenticated user. +Sets a default address for the authenticated user. Requires one of the following permissions: AUTHENTICATED_USER. @@ -31541,7 +30485,7 @@ Triggers the following webhook events: type AccountSetDefaultAddress @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED], syncEvents: []) { """An updated user instance.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } @@ -31554,11 +30498,12 @@ Triggers the following webhook events: - 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: []) { + 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.""" requiresConfirmation: Boolean - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! - user: User } """Fields required to create a user.""" @@ -31583,7 +30528,11 @@ input AccountRegisterInput @doc(category: "Users") { """ redirectUrl: String - """User public metadata.""" + """ + User public metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. + """ metadata: [MetadataInput!] """ @@ -31602,7 +30551,7 @@ Triggers the following webhook events: - 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: []) { - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! user: User } @@ -31625,15 +30574,15 @@ input AccountInput @doc(category: "Users") { defaultShippingAddress: AddressInput """ - Fields required to update the user metadata. - - Added in Saleor 3.14. + Fields required to update the user metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] } """ -Sends an email with the account removal link for the logged-in user. +Sends an email with the account removal link for the logged-in user. Requires one of the following permissions: AUTHENTICATED_USER. @@ -31642,12 +30591,12 @@ Triggers the following webhook events: - ACCOUNT_DELETE_REQUESTED (async): An account delete requested. """ type AccountRequestDeletion @doc(category: "Users") @webhookEventsInfo(asyncEvents: [NOTIFY_USER, ACCOUNT_DELETE_REQUESTED], syncEvents: []) { - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } """ -Remove user account. +Remove user account. Requires one of the following permissions: AUTHENTICATED_USER. @@ -31655,13 +30604,13 @@ Triggers the following webhook events: - ACCOUNT_DELETED (async): Account was deleted. """ type AccountDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ACCOUNT_DELETED], syncEvents: []) { - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! user: User } """ -Creates user address. +Creates user address. Requires one of the following permissions: MANAGE_USERS. @@ -31671,13 +30620,13 @@ Triggers the following webhook events: type AddressCreate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_CREATED], syncEvents: []) { """A user instance for which the address was created.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! address: Address } """ -Updates an address. +Updates an address. Requires one of the following permissions: MANAGE_USERS. @@ -31687,13 +30636,13 @@ Triggers the following webhook events: type AddressUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_UPDATED], syncEvents: []) { """A user object for which the address was edited.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! address: Address } """ -Deletes an address. +Deletes an address. Requires one of the following permissions: MANAGE_USERS. @@ -31703,13 +30652,13 @@ Triggers the following webhook events: type AddressDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [ADDRESS_DELETED], syncEvents: []) { """A user instance for which the address was deleted.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! address: Address } """ -Sets a default address for the given user. +Sets a default address for the given user. Requires one of the following permissions: MANAGE_USERS. @@ -31719,12 +30668,12 @@ Triggers the following webhook events: type AddressSetDefault @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_UPDATED], syncEvents: []) { """An updated user instance.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } """ -Creates a new customer. +Creates a new customer. Requires one of the following permissions: MANAGE_USERS. @@ -31735,7 +30684,7 @@ Triggers the following webhook events: - 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: []) { - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! user: User } @@ -31763,39 +30712,27 @@ input UserCreateInput @doc(category: "Users") { note: String """ - Fields required to update the user metadata. - - Added in Saleor 3.14. + Fields required to update the user metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Fields required to update the user private metadata. - - Added in Saleor 3.14. + Fields required to update the user private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] """User language code.""" languageCode: LanguageCodeEnum - """ - External ID of the customer. - - Added in Saleor 3.10. - """ + """External ID of the customer.""" externalReference: String - """ - User account is confirmed. - - Added in Saleor 3.15. - - DEPRECATED: this field will be removed in Saleor 4.0. - - The user will be always set as unconfirmed. The confirmation will take place when the user sets the password. - """ - isConfirmed: Boolean + """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.") """ URL of a view where users should be redirected to set the password. URL in RFC 1808 format. @@ -31809,7 +30746,7 @@ input UserCreateInput @doc(category: "Users") { } """ -Updates an existing customer. +Updates an existing customer. Requires one of the following permissions: MANAGE_USERS. @@ -31818,7 +30755,7 @@ Triggers the following webhook events: - 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: []) { - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! user: User } @@ -31846,39 +30783,31 @@ input CustomerInput @doc(category: "Users") { note: String """ - Fields required to update the user metadata. - - Added in Saleor 3.14. + Fields required to update the user metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Fields required to update the user private metadata. - - Added in Saleor 3.14. + Fields required to update the user private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] """User language code.""" languageCode: LanguageCodeEnum - """ - External ID of the customer. - - Added in Saleor 3.10. - """ + """External ID of the customer.""" externalReference: String - """ - User account is confirmed. - - Added in Saleor 3.15. - """ + """User account is confirmed.""" isConfirmed: Boolean } """ -Deletes a customer. +Deletes a customer. Requires one of the following permissions: MANAGE_USERS. @@ -31886,13 +30815,13 @@ Triggers the following webhook events: - CUSTOMER_DELETED (async): A customer account was deleted. """ type CustomerDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_DELETED], syncEvents: []) { - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! user: User } """ -Deletes customers. +Deletes customers. Requires one of the following permissions: MANAGE_USERS. @@ -31902,17 +30831,13 @@ Triggers the following webhook events: type CustomerBulkDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [CUSTOMER_DELETED], syncEvents: []) { """Returns how many objects were affected.""" count: Int! - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } """ Updates customers. -Added in Saleor 3.13. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. - Requires one of the following permissions: MANAGE_USERS. Triggers the following webhook events: @@ -31949,7 +30874,6 @@ type CustomerBulkUpdateError @doc(category: "Users") { code: CustomerBulkUpdateErrorCode! } -"""An enumeration.""" enum CustomerBulkUpdateErrorCode @doc(category: "Users") { BLANK DUPLICATED_INPUT_ITEM @@ -31973,7 +30897,7 @@ input CustomerBulkUpdateInput @doc(category: "Users") { } """ -Creates a new staff user. Apps are not allowed to perform this mutation. +Creates a new staff user. Apps are not allowed to perform this mutation. Requires one of the following permissions: MANAGE_STAFF. @@ -31983,7 +30907,7 @@ Triggers the following webhook events: - 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: []) { - staffErrors: [StaffError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + staffErrors: [StaffError!]! @deprecated(reason: "Use `errors` field instead.") errors: [StaffError!]! user: User } @@ -32031,16 +30955,16 @@ input StaffCreateInput @doc(category: "Users") { note: String """ - Fields required to update the user metadata. - - Added in Saleor 3.14. + Fields required to update the user metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Fields required to update the user private metadata. - - Added in Saleor 3.14. + Fields required to update the user private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] @@ -32054,7 +30978,7 @@ input StaffCreateInput @doc(category: "Users") { } """ -Updates an existing staff user. Apps are not allowed to perform this mutation. +Updates an existing staff user. Apps are not allowed to perform this mutation. Requires one of the following permissions: MANAGE_STAFF. @@ -32062,7 +30986,7 @@ Triggers the following webhook events: - STAFF_UPDATED (async): A staff account was updated. """ type StaffUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [STAFF_UPDATED], syncEvents: []) { - staffErrors: [StaffError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + staffErrors: [StaffError!]! @deprecated(reason: "Use `errors` field instead.") errors: [StaffError!]! user: User } @@ -32085,16 +31009,16 @@ input StaffUpdateInput @doc(category: "Users") { note: String """ - Fields required to update the user metadata. - - Added in Saleor 3.14. + Fields required to update the user metadata. Can be read by any API client authorized to read the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ metadata: [MetadataInput!] """ - Fields required to update the user private metadata. - - Added in Saleor 3.14. + Fields required to update the user private metadata. Requires permissions to modify and to read the metadata of the object it's attached to. + + Warning: never store sensitive information, including financial data such as credit card details. """ privateMetadata: [MetadataInput!] @@ -32106,7 +31030,7 @@ input StaffUpdateInput @doc(category: "Users") { } """ -Deletes a staff user. Apps are not allowed to perform this mutation. +Deletes a staff user. Apps are not allowed to perform this mutation. Requires one of the following permissions: MANAGE_STAFF. @@ -32114,13 +31038,13 @@ Triggers the following webhook events: - STAFF_DELETED (async): A staff account was deleted. """ type StaffDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [STAFF_DELETED], syncEvents: []) { - staffErrors: [StaffError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + staffErrors: [StaffError!]! @deprecated(reason: "Use `errors` field instead.") errors: [StaffError!]! user: User } """ -Deletes staff users. Apps are not allowed to perform this mutation. +Deletes staff users. Apps are not allowed to perform this mutation. Requires one of the following permissions: MANAGE_STAFF. @@ -32130,48 +31054,48 @@ Triggers the following webhook events: type StaffBulkDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [STAFF_DELETED], syncEvents: []) { """Returns how many objects were affected.""" count: Int! - staffErrors: [StaffError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + staffErrors: [StaffError!]! @deprecated(reason: "Use `errors` field instead.") errors: [StaffError!]! } """ -Create a user avatar. Only for staff members. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec +Create a user avatar. Only for staff members. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec Requires one of the following permissions: AUTHENTICATED_STAFF_USER. """ type UserAvatarUpdate @doc(category: "Users") { """An updated user instance.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } """ -Deletes a user avatar. Only for staff members. +Deletes a user avatar. Only for staff members. Requires one of the following permissions: AUTHENTICATED_STAFF_USER. """ type UserAvatarDelete @doc(category: "Users") { """An updated user instance.""" user: User - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } """ -Activate or deactivate users. +Activate or deactivate users. Requires one of the following permissions: MANAGE_USERS. """ type UserBulkSetActive @doc(category: "Users") { """Returns how many objects were affected.""" count: Int! - accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + accountErrors: [AccountError!]! @deprecated(reason: "Use `errors` field instead.") errors: [AccountError!]! } """ -Create new permission group. Apps are not allowed to perform this mutation. +Create new permission group. Apps are not allowed to perform this mutation. Requires one of the following permissions: MANAGE_STAFF. @@ -32179,7 +31103,7 @@ Triggers the following webhook events: - PERMISSION_GROUP_CREATED (async) """ type PermissionGroupCreate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [PERMISSION_GROUP_CREATED], syncEvents: []) { - permissionGroupErrors: [PermissionGroupError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + permissionGroupErrors: [PermissionGroupError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PermissionGroupError!]! group: Group } @@ -32206,7 +31130,6 @@ type PermissionGroupError @doc(category: "Users") { channels: [ID!] } -"""An enumeration.""" enum PermissionGroupErrorCode @doc(category: "Users") { REQUIRED UNIQUE @@ -32226,13 +31149,7 @@ input PermissionGroupCreateInput @doc(category: "Users") { """List of users to assign to this group.""" addUsers: [ID!] - """ - List of channels to assign to this group. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """List of channels to assign to this group.""" addChannels: [ID!] """Group name.""" @@ -32240,16 +31157,12 @@ input PermissionGroupCreateInput @doc(category: "Users") { """ Determine if the group has restricted access to channels. DEFAULT: False - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ restrictedAccessToChannels: Boolean = false } """ -Update permission group. Apps are not allowed to perform this mutation. +Update permission group. Apps are not allowed to perform this mutation. Requires one of the following permissions: MANAGE_STAFF. @@ -32257,7 +31170,7 @@ Triggers the following webhook events: - PERMISSION_GROUP_UPDATED (async) """ type PermissionGroupUpdate @doc(category: "Users") @webhookEventsInfo(asyncEvents: [PERMISSION_GROUP_UPDATED], syncEvents: []) { - permissionGroupErrors: [PermissionGroupError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + permissionGroupErrors: [PermissionGroupError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PermissionGroupError!]! group: Group } @@ -32269,13 +31182,7 @@ input PermissionGroupUpdateInput @doc(category: "Users") { """List of users to assign to this group.""" addUsers: [ID!] - """ - List of channels to assign to this group. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """List of channels to assign to this group.""" addChannels: [ID!] """Group name.""" @@ -32287,27 +31194,15 @@ input PermissionGroupUpdateInput @doc(category: "Users") { """List of users to unassign from this group.""" removeUsers: [ID!] - """ - List of channels to unassign from this group. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """List of channels to unassign from this group.""" removeChannels: [ID!] - """ - Determine if the group has restricted access to channels. - - Added in Saleor 3.14. - - Note: this API is currently in Feature Preview and can be subject to changes at later point. - """ + """Determine if the group has restricted access to channels.""" restrictedAccessToChannels: Boolean } """ -Delete permission group. Apps are not allowed to perform this mutation. +Delete permission group. Apps are not allowed to perform this mutation. Requires one of the following permissions: MANAGE_STAFF. @@ -32315,228 +31210,302 @@ Triggers the following webhook events: - PERMISSION_GROUP_DELETED (async) """ type PermissionGroupDelete @doc(category: "Users") @webhookEventsInfo(asyncEvents: [PERMISSION_GROUP_DELETED], syncEvents: []) { - permissionGroupErrors: [PermissionGroupError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.") + permissionGroupErrors: [PermissionGroupError!]! @deprecated(reason: "Use `errors` field instead.") errors: [PermissionGroupError!]! group: Group } type Subscription @doc(category: "Miscellaneous") { - """ - Look up subscription event. - - Added in Saleor 3.2. - """ + """Look up subscription event.""" event: Event """ Event sent when new draft order is created. - + Added in Saleor 3.20. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ draftOrderCreated( """ - List of channel slugs. The event will be sent only if the order belongs to one of the provided channels. If the channel slug list is empty, orders that belong to any channel will be sent. Maximally 500 items. + 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 + ): DraftOrderCreated @doc(category: "Orders") """ Event sent when draft order is updated. - + Added in Saleor 3.20. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ draftOrderUpdated( """ - List of channel slugs. The event will be sent only if the order belongs to one of the provided channels. If the channel slug list is empty, orders that belong to any channel will be sent. Maximally 500 items. + 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 + ): DraftOrderUpdated @doc(category: "Orders") """ Event sent when draft order is deleted. - + Added in Saleor 3.20. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ draftOrderDeleted( """ - List of channel slugs. The event will be sent only if the order belongs to one of the provided channels. If the channel slug list is empty, orders that belong to any channel will be sent. Maximally 500 items. + 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 + ): DraftOrderDeleted @doc(category: "Orders") """ Event sent when new order is created. - + Added in Saleor 3.20. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ orderCreated( """ - List of channel slugs. The event will be sent only if the order belongs to one of the provided channels. If the channel slug list is empty, orders that belong to any channel will be sent. Maximally 500 items. + 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 + ): OrderCreated @doc(category: "Orders") """ Event sent when order is updated. - + Added in Saleor 3.20. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ orderUpdated( """ - List of channel slugs. The event will be sent only if the order belongs to one of the provided channels. If the channel slug list is empty, orders that belong to any channel will be sent. Maximally 500 items. + 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 + ): OrderUpdated @doc(category: "Orders") """ Event sent when order is confirmed. - + Added in Saleor 3.20. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ orderConfirmed( """ - List of channel slugs. The event will be sent only if the order belongs to one of the provided channels. If the channel slug list is empty, orders that belong to any channel will be sent. Maximally 500 items. + 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 + ): OrderConfirmed @doc(category: "Orders") """ Payment has been made. The order may be partially or fully paid. - + Added in Saleor 3.20. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ orderPaid( """ - List of channel slugs. The event will be sent only if the order belongs to one of the provided channels. If the channel slug list is empty, orders that belong to any channel will be sent. Maximally 500 items. + 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 + ): OrderPaid @doc(category: "Orders") """ Event sent when order is fully paid. - + Added in Saleor 3.20. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ orderFullyPaid( """ - List of channel slugs. The event will be sent only if the order belongs to one of the provided channels. If the channel slug list is empty, orders that belong to any channel will be sent. Maximally 500 items. + 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 + ): OrderFullyPaid @doc(category: "Orders") """ The order received a refund. The order may be partially or fully refunded. - + Added in Saleor 3.20. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ orderRefunded( """ - List of channel slugs. The event will be sent only if the order belongs to one of the provided channels. If the channel slug list is empty, orders that belong to any channel will be sent. Maximally 500 items. + 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 + ): OrderRefunded @doc(category: "Orders") """ The order is fully refunded. - + Added in Saleor 3.20. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ orderFullyRefunded( """ - List of channel slugs. The event will be sent only if the order belongs to one of the provided channels. If the channel slug list is empty, orders that belong to any channel will be sent. Maximally 500 items. + 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 + ): OrderFullyRefunded @doc(category: "Orders") """ Event sent when order is fulfilled. - + Added in Saleor 3.20. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ orderFulfilled( """ - List of channel slugs. The event will be sent only if the order belongs to one of the provided channels. If the channel slug list is empty, orders that belong to any channel will be sent. Maximally 500 items. + 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 + ): OrderFulfilled @doc(category: "Orders") """ Event sent when order is cancelled. - + Added in Saleor 3.20. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ orderCancelled( """ - List of channel slugs. The event will be sent only if the order belongs to one of the provided channels. If the channel slug list is empty, orders that belong to any channel will be sent. Maximally 500 items. + 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 + ): OrderCancelled @doc(category: "Orders") """ Event sent when order becomes expired. - + Added in Saleor 3.20. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ orderExpired( """ - List of channel slugs. The event will be sent only if the order belongs to one of the provided channels. If the channel slug list is empty, orders that belong to any channel will be sent. Maximally 500 items. + 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 + ): OrderExpired @doc(category: "Orders") """ Event sent when order metadata is updated. - + Added in Saleor 3.20. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ orderMetadataUpdated( """ - List of channel slugs. The event will be sent only if the order belongs to one of the provided channels. If the channel slug list is empty, orders that belong to any channel will be sent. Maximally 500 items. + 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 + ): OrderMetadataUpdated @doc(category: "Orders") """ Event sent when orders are imported. - + Added in Saleor 3.20. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ orderBulkCreated( """ - List of channel slugs. The event will be sent only if the order belongs to one of the provided channels. If the channel slug list is empty, orders that belong to any channel will be sent. Maximally 500 items. + 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") + + """Synchronous webhook for calculating checkout/order taxes.""" + calculateTaxes( + """ + List of conditions under which the webhook delivery should be deferred (skipped). If any condition evaluates to true, the webhook will not be delivered. + """ + deferIf: [WebhookDeferIfConditionEnum!] + ): CalculateTaxes @doc(category: "Taxes") + + """ + Event sent when new checkout is created. + + Added in Saleor 3.21. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + checkoutCreated( + """ + 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") + + """ + Event sent when checkout is updated. + + Added in Saleor 3.21. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + checkoutUpdated( + """ + 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") + + """ + Event sent when checkout is fully-paid. + + Added in Saleor 3.21. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + checkoutFullyPaid( + """ + 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") + + """ + Event sent when checkout is fully authorized. + + Added in Saleor 3.21. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + checkoutFullyAuthorized( + """ + 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") + + """ + Event sent when checkout metadata is updated. + + Added in Saleor 3.21. + + Note: this API is currently in Feature Preview and can be subject to changes at later point. + """ + checkoutMetadataUpdated( + """ + 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 + ): CheckoutMetadataUpdated @doc(category: "Checkout") } interface Event { @@ -32555,11 +31524,7 @@ interface Event { union IssuingPrincipal = App | User -""" -Event sent when new draft order is created. - -Added in Saleor 3.2. -""" +"""Event sent when new draft order is created.""" type DraftOrderCreated implements Event @doc(category: "Orders") { """Time of the event.""" issuedAt: DateTime @@ -32577,11 +31542,7 @@ type DraftOrderCreated implements Event @doc(category: "Orders") { order: Order } -""" -Event sent when draft order is updated. - -Added in Saleor 3.2. -""" +"""Event sent when draft order is updated.""" type DraftOrderUpdated implements Event @doc(category: "Orders") { """Time of the event.""" issuedAt: DateTime @@ -32599,11 +31560,7 @@ type DraftOrderUpdated implements Event @doc(category: "Orders") { order: Order } -""" -Event sent when draft order is deleted. - -Added in Saleor 3.2. -""" +"""Event sent when draft order is deleted.""" type DraftOrderDeleted implements Event @doc(category: "Orders") { """Time of the event.""" issuedAt: DateTime @@ -32621,11 +31578,7 @@ type DraftOrderDeleted implements Event @doc(category: "Orders") { order: Order } -""" -Event sent when new order is created. - -Added in Saleor 3.2. -""" +"""Event sent when new order is created.""" type OrderCreated implements Event @doc(category: "Orders") { """Time of the event.""" issuedAt: DateTime @@ -32643,11 +31596,7 @@ type OrderCreated implements Event @doc(category: "Orders") { order: Order } -""" -Event sent when order is updated. - -Added in Saleor 3.2. -""" +"""Event sent when order is updated.""" type OrderUpdated implements Event @doc(category: "Orders") { """Time of the event.""" issuedAt: DateTime @@ -32665,11 +31614,7 @@ type OrderUpdated implements Event @doc(category: "Orders") { order: Order } -""" -Event sent when order is confirmed. - -Added in Saleor 3.2. -""" +"""Event sent when order is confirmed.""" type OrderConfirmed implements Event @doc(category: "Orders") { """Time of the event.""" issuedAt: DateTime @@ -32687,14 +31632,26 @@ type OrderConfirmed implements Event @doc(category: "Orders") { order: Order } -""" -Payment has been made. The order may be partially or fully paid. +"""Payment has been made. The order may be partially or fully paid.""" +type OrderPaid implements Event @doc(category: "Orders") { + """Time of the event.""" + issuedAt: DateTime + + """Saleor version that triggered the event.""" + version: String -Added in Saleor 3.14. + """The user or application that triggered the event.""" + issuingPrincipal: IssuingPrincipal -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" -type OrderPaid implements Event @doc(category: "Orders") { + """The application receiving the webhook.""" + recipient: App + + """The order the event relates to.""" + order: Order +} + +"""Event sent when order is fully paid.""" +type OrderFullyPaid implements Event @doc(category: "Orders") { """Time of the event.""" issuedAt: DateTime @@ -32712,11 +31669,99 @@ type OrderPaid implements Event @doc(category: "Orders") { } """ -Event sent when order is fully paid. - -Added in Saleor 3.2. +The order received a refund. The order may be partially or fully refunded. """ -type OrderFullyPaid implements Event @doc(category: "Orders") { +type OrderRefunded implements Event @doc(category: "Orders") { + """Time of the event.""" + issuedAt: DateTime + + """Saleor version that triggered the event.""" + version: String + + """The user or application that triggered the event.""" + issuingPrincipal: IssuingPrincipal + + """The application receiving the webhook.""" + recipient: App + + """The order the event relates to.""" + order: Order +} + +"""The order is fully refunded.""" +type OrderFullyRefunded implements Event @doc(category: "Orders") { + """Time of the event.""" + issuedAt: DateTime + + """Saleor version that triggered the event.""" + version: String + + """The user or application that triggered the event.""" + issuingPrincipal: IssuingPrincipal + + """The application receiving the webhook.""" + recipient: App + + """The order the event relates to.""" + order: Order +} + +"""Event sent when order is fulfilled.""" +type OrderFulfilled implements Event @doc(category: "Orders") { + """Time of the event.""" + issuedAt: DateTime + + """Saleor version that triggered the event.""" + version: String + + """The user or application that triggered the event.""" + issuingPrincipal: IssuingPrincipal + + """The application receiving the webhook.""" + recipient: App + + """The order the event relates to.""" + order: Order +} + +"""Event sent when order is canceled.""" +type OrderCancelled implements Event @doc(category: "Orders") { + """Time of the event.""" + issuedAt: DateTime + + """Saleor version that triggered the event.""" + version: String + + """The user or application that triggered the event.""" + issuingPrincipal: IssuingPrincipal + + """The application receiving the webhook.""" + recipient: App + + """The order the event relates to.""" + order: Order +} + +"""Event sent when order becomes expired.""" +type OrderExpired implements Event @doc(category: "Orders") { + """Time of the event.""" + issuedAt: DateTime + + """Saleor version that triggered the event.""" + version: String + + """The user or application that triggered the event.""" + issuingPrincipal: IssuingPrincipal + + """The application receiving the webhook.""" + recipient: App + + """The order the event relates to.""" + order: Order +} + +"""Event sent when order metadata is updated.""" +type OrderMetadataUpdated implements Event @doc(category: "Orders") { """Time of the event.""" issuedAt: DateTime @@ -32733,14 +31778,8 @@ type OrderFullyPaid implements Event @doc(category: "Orders") { order: Order } -""" -The order received a refund. The order may be partially or fully refunded. - -Added in Saleor 3.14. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" -type OrderRefunded implements Event @doc(category: "Orders") { +"""Event sent when orders are imported.""" +type OrderBulkCreated implements Event @doc(category: "Orders") { """Time of the event.""" issuedAt: DateTime @@ -32753,18 +31792,12 @@ type OrderRefunded implements Event @doc(category: "Orders") { """The application receiving the webhook.""" recipient: App - """The order the event relates to.""" - order: Order + """The orders the event relates to.""" + orders: [Order!] } -""" -The order is fully refunded. - -Added in Saleor 3.14. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" -type OrderFullyRefunded implements Event @doc(category: "Orders") { +"""Synchronous webhook for calculating checkout/order taxes.""" +type CalculateTaxes implements Event @doc(category: "Taxes") { """Time of the event.""" issuedAt: DateTime @@ -32776,17 +31809,99 @@ type OrderFullyRefunded implements Event @doc(category: "Orders") { """The application receiving the webhook.""" recipient: App + taxBase: TaxableObject! +} - """The order the event relates to.""" - order: Order +"""Taxable object.""" +type TaxableObject @doc(category: "Taxes") { + """The source object related to this tax object.""" + sourceObject: TaxSourceObject! + + """Determines if prices contain entered tax..""" + pricesEnteredWithTax: Boolean! + + """The currency of the object.""" + currency: String! + + """ + The price of shipping method, includes shipping voucher discount if applied. + """ + shippingPrice: Money! + + """The address data.""" + address: Address + + """List of discounts.""" + discounts: [TaxableObjectDiscount!]! + + """List of lines assigned to the object.""" + lines: [TaxableObjectLine!]! + channel: Channel! } +"""Taxable object discount.""" +type TaxableObjectDiscount @doc(category: "Taxes") { + """The name of the discount.""" + name: String + + """The amount of the discount.""" + amount: Money! + + """ + Indicates which part of the order the discount should affect: SUBTOTAL or SHIPPING. + """ + type: TaxableObjectDiscountTypeEnum! +} + +""" +Indicates which part of the order the discount should affect: SUBTOTAL or SHIPPING. """ -Event sent when order is fulfilled. +enum TaxableObjectDiscountTypeEnum @doc(category: "Taxes") { + SUBTOTAL + SHIPPING +} + +type TaxableObjectLine @doc(category: "Taxes") { + """The source line related to this tax line.""" + sourceLine: TaxSourceLine! + + """Number of items.""" + quantity: Int! + + """Determines if taxes are being charged for the product.""" + chargeTaxes: Boolean! + + """The product name.""" + productName: String! + + """The variant name.""" + variantName: String! + + """The product sku.""" + productSku: String + + """ + Price of the single item in the order line. The price includes catalogue promotions, specific product and applied once per order voucher discounts. The price does not include the entire order discount. + """ + unitPrice: Money! + + """ + Price of the order line. The price includes catalogue promotions, specific product and applied once per order voucher discounts. The price does not include the entire order discount. + """ + totalPrice: Money! +} + +union TaxSourceLine = CheckoutLine | OrderLine -Added in Saleor 3.2. """ -type OrderFulfilled implements Event @doc(category: "Orders") { +Conditions under which a webhook delivery should be deferred. If any condition evaluates to true, the webhook will not fire. +""" +enum WebhookDeferIfConditionEnum { + ADDRESS_MISSING +} + +"""Event sent when new checkout is created.""" +type CheckoutCreated implements Event @doc(category: "Checkout") { """Time of the event.""" issuedAt: DateTime @@ -32799,16 +31914,12 @@ type OrderFulfilled implements Event @doc(category: "Orders") { """The application receiving the webhook.""" recipient: App - """The order the event relates to.""" - order: Order + """The checkout the event relates to.""" + checkout: Checkout } -""" -Event sent when order is canceled. - -Added in Saleor 3.2. -""" -type OrderCancelled implements Event @doc(category: "Orders") { +"""Event sent when checkout is updated.""" +type CheckoutUpdated implements Event @doc(category: "Checkout") { """Time of the event.""" issuedAt: DateTime @@ -32821,18 +31932,16 @@ type OrderCancelled implements Event @doc(category: "Orders") { """The application receiving the webhook.""" recipient: App - """The order the event relates to.""" - order: Order + """The checkout the event relates to.""" + checkout: Checkout } """ -Event sent when order becomes expired. +Event sent when a checkout was fully paid. A checkout is considered fully paid when its `chargeStatus` is `FULL` or `OVERCHARGED`. This event is not sent if payments are only authorized but not fully charged. -Added in Saleor 3.13. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. +It is triggered only for checkouts whose payments are processed through the Transaction API. """ -type OrderExpired implements Event @doc(category: "Orders") { +type CheckoutFullyPaid implements Event @doc(category: "Checkout") { """Time of the event.""" issuedAt: DateTime @@ -32845,16 +31954,16 @@ type OrderExpired implements Event @doc(category: "Orders") { """The application receiving the webhook.""" recipient: App - """The order the event relates to.""" - order: Order + """The checkout the event relates to.""" + checkout: Checkout } """ -Event sent when order metadata is updated. +Event sent when a checkout was fully authorized. A checkout is considered fully authorized when its `authorizeStatus` is `FULL`. -Added in Saleor 3.8. +It is triggered only for checkouts whose payments are processed through the Transaction API. """ -type OrderMetadataUpdated implements Event @doc(category: "Orders") { +type CheckoutFullyAuthorized implements Event @doc(category: "Checkout") { """Time of the event.""" issuedAt: DateTime @@ -32867,18 +31976,12 @@ type OrderMetadataUpdated implements Event @doc(category: "Orders") { """The application receiving the webhook.""" recipient: App - """The order the event relates to.""" - order: Order + """The checkout the event relates to.""" + checkout: Checkout } -""" -Event sent when orders are imported. - -Added in Saleor 3.14. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" -type OrderBulkCreated implements Event @doc(category: "Orders") { +"""Event sent when checkout metadata is updated.""" +type CheckoutMetadataUpdated implements Event @doc(category: "Checkout") { """Time of the event.""" issuedAt: DateTime @@ -32891,11 +31994,10 @@ type OrderBulkCreated implements Event @doc(category: "Orders") { """The application receiving the webhook.""" recipient: App - """The orders the event relates to.""" - orders: [Order!] + """The checkout the event relates to.""" + checkout: Checkout } -"""An enumeration.""" enum DistanceUnitsEnum { MM CM @@ -32907,7 +32009,6 @@ enum DistanceUnitsEnum { INCH } -"""An enumeration.""" enum AreaUnitsEnum { SQ_MM SQ_CM @@ -32919,7 +32020,6 @@ enum AreaUnitsEnum { SQ_INCH } -"""An enumeration.""" enum VolumeUnitsEnum { CUBIC_MILLIMETER CUBIC_CENTIMETER @@ -32938,8 +32038,6 @@ enum VolumeUnitsEnum { """ Event sent when account confirmation requested. This event is always sent. enableAccountConfirmationByEmail flag set to True is not required. - -Added in Saleor 3.15. """ type AccountConfirmationRequested implements Event @doc(category: "Users") { """Time of the event.""" @@ -32970,11 +32068,7 @@ type AccountConfirmationRequested implements Event @doc(category: "Users") { shop: Shop } -""" -Event sent when account change email is requested. - -Added in Saleor 3.15. -""" +"""Event sent when account change email is requested.""" type AccountChangeEmailRequested implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -33007,11 +32101,7 @@ type AccountChangeEmailRequested implements Event @doc(category: "Users") { newEmail: String } -""" -Event sent when account email is changed. - -Added in Saleor 3.15. -""" +"""Event sent when account email is changed.""" type AccountEmailChanged implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -33044,11 +32134,7 @@ type AccountEmailChanged implements Event @doc(category: "Users") { newEmail: String } -""" -Event sent when setting a new password is requested. - -Added in Saleor 3.15. -""" +"""Event sent when setting a new password is requested.""" type AccountSetPasswordRequested implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -33078,11 +32164,7 @@ type AccountSetPasswordRequested implements Event @doc(category: "Users") { shop: Shop } -""" -Event sent when account is confirmed. - -Added in Saleor 3.15. -""" +"""Event sent when account is confirmed.""" type AccountConfirmed implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -33112,11 +32194,7 @@ type AccountConfirmed implements Event @doc(category: "Users") { shop: Shop } -""" -Event sent when account delete is requested. - -Added in Saleor 3.15. -""" +"""Event sent when account delete is requested.""" type AccountDeleteRequested implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -33146,11 +32224,7 @@ type AccountDeleteRequested implements Event @doc(category: "Users") { shop: Shop } -""" -Event sent when account is deleted. - -Added in Saleor 3.15. -""" +"""Event sent when account is deleted.""" type AccountDeleted implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -33180,11 +32254,7 @@ type AccountDeleted implements Event @doc(category: "Users") { shop: Shop } -""" -Event sent when new address is created. - -Added in Saleor 3.5. -""" +"""Event sent when new address is created.""" type AddressCreated implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -33202,11 +32272,7 @@ type AddressCreated implements Event @doc(category: "Users") { address: Address } -""" -Event sent when address is updated. - -Added in Saleor 3.5. -""" +"""Event sent when address is updated.""" type AddressUpdated implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -33224,11 +32290,7 @@ type AddressUpdated implements Event @doc(category: "Users") { address: Address } -""" -Event sent when address is deleted. - -Added in Saleor 3.5. -""" +"""Event sent when address is deleted.""" type AddressDeleted implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -33246,11 +32308,7 @@ type AddressDeleted implements Event @doc(category: "Users") { address: Address } -""" -Event sent when new app is installed. - -Added in Saleor 3.4. -""" +"""Event sent when new app is installed.""" type AppInstalled implements Event @doc(category: "Apps") { """Time of the event.""" issuedAt: DateTime @@ -33268,11 +32326,7 @@ type AppInstalled implements Event @doc(category: "Apps") { app: App } -""" -Event sent when app is updated. - -Added in Saleor 3.4. -""" +"""Event sent when app is updated.""" type AppUpdated implements Event @doc(category: "Apps") { """Time of the event.""" issuedAt: DateTime @@ -33290,11 +32344,7 @@ type AppUpdated implements Event @doc(category: "Apps") { app: App } -""" -Event sent when app is deleted. - -Added in Saleor 3.4. -""" +"""Event sent when app is deleted.""" type AppDeleted implements Event @doc(category: "Apps") { """Time of the event.""" issuedAt: DateTime @@ -33312,11 +32362,7 @@ type AppDeleted implements Event @doc(category: "Apps") { app: App } -""" -Event sent when app status has changed. - -Added in Saleor 3.4. -""" +"""Event sent when app status has changed.""" type AppStatusChanged implements Event @doc(category: "Apps") { """Time of the event.""" issuedAt: DateTime @@ -33334,11 +32380,7 @@ type AppStatusChanged implements Event @doc(category: "Apps") { app: App } -""" -Event sent when new attribute is created. - -Added in Saleor 3.5. -""" +"""Event sent when new attribute is created.""" type AttributeCreated implements Event @doc(category: "Attributes") { """Time of the event.""" issuedAt: DateTime @@ -33356,11 +32398,7 @@ type AttributeCreated implements Event @doc(category: "Attributes") { attribute: Attribute } -""" -Event sent when attribute is updated. - -Added in Saleor 3.5. -""" +"""Event sent when attribute is updated.""" type AttributeUpdated implements Event @doc(category: "Attributes") { """Time of the event.""" issuedAt: DateTime @@ -33378,11 +32416,7 @@ type AttributeUpdated implements Event @doc(category: "Attributes") { attribute: Attribute } -""" -Event sent when attribute is deleted. - -Added in Saleor 3.5. -""" +"""Event sent when attribute is deleted.""" type AttributeDeleted implements Event @doc(category: "Attributes") { """Time of the event.""" issuedAt: DateTime @@ -33400,11 +32434,7 @@ type AttributeDeleted implements Event @doc(category: "Attributes") { attribute: Attribute } -""" -Event sent when new attribute value is created. - -Added in Saleor 3.5. -""" +"""Event sent when new attribute value is created.""" type AttributeValueCreated implements Event @doc(category: "Attributes") { """Time of the event.""" issuedAt: DateTime @@ -33422,11 +32452,7 @@ type AttributeValueCreated implements Event @doc(category: "Attributes") { attributeValue: AttributeValue } -""" -Event sent when attribute value is updated. - -Added in Saleor 3.5. -""" +"""Event sent when attribute value is updated.""" type AttributeValueUpdated implements Event @doc(category: "Attributes") { """Time of the event.""" issuedAt: DateTime @@ -33444,11 +32470,7 @@ type AttributeValueUpdated implements Event @doc(category: "Attributes") { attributeValue: AttributeValue } -""" -Event sent when attribute value is deleted. - -Added in Saleor 3.5. -""" +"""Event sent when attribute value is deleted.""" type AttributeValueDeleted implements Event @doc(category: "Attributes") { """Time of the event.""" issuedAt: DateTime @@ -33466,11 +32488,7 @@ type AttributeValueDeleted implements Event @doc(category: "Attributes") { attributeValue: AttributeValue } -""" -Event sent when new category is created. - -Added in Saleor 3.2. -""" +"""Event sent when new category is created.""" type CategoryCreated implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -33488,11 +32506,7 @@ type CategoryCreated implements Event @doc(category: "Products") { category: Category } -""" -Event sent when category is updated. - -Added in Saleor 3.2. -""" +"""Event sent when category is updated.""" type CategoryUpdated implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -33510,11 +32524,7 @@ type CategoryUpdated implements Event @doc(category: "Products") { category: Category } -""" -Event sent when category is deleted. - -Added in Saleor 3.2. -""" +"""Event sent when category is deleted.""" type CategoryDeleted implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -33532,11 +32542,7 @@ type CategoryDeleted implements Event @doc(category: "Products") { category: Category } -""" -Event sent when new channel is created. - -Added in Saleor 3.2. -""" +"""Event sent when new channel is created.""" type ChannelCreated implements Event @doc(category: "Channels") { """Time of the event.""" issuedAt: DateTime @@ -33554,11 +32560,7 @@ type ChannelCreated implements Event @doc(category: "Channels") { channel: Channel } -""" -Event sent when channel is updated. - -Added in Saleor 3.2. -""" +"""Event sent when channel is updated.""" type ChannelUpdated implements Event @doc(category: "Channels") { """Time of the event.""" issuedAt: DateTime @@ -33576,11 +32578,7 @@ type ChannelUpdated implements Event @doc(category: "Channels") { channel: Channel } -""" -Event sent when channel is deleted. - -Added in Saleor 3.2. -""" +"""Event sent when channel is deleted.""" type ChannelDeleted implements Event @doc(category: "Channels") { """Time of the event.""" issuedAt: DateTime @@ -33598,11 +32596,7 @@ type ChannelDeleted implements Event @doc(category: "Channels") { channel: Channel } -""" -Event sent when channel status has changed. - -Added in Saleor 3.2. -""" +"""Event sent when channel status has changed.""" type ChannelStatusChanged implements Event @doc(category: "Channels") { """Time of the event.""" issuedAt: DateTime @@ -33620,11 +32614,7 @@ type ChannelStatusChanged implements Event @doc(category: "Channels") { channel: Channel } -""" -Event sent when channel metadata is updated. - -Added in Saleor 3.15. -""" +"""Event sent when channel metadata is updated.""" type ChannelMetadataUpdated implements Event @doc(category: "Channels") { """Time of the event.""" issuedAt: DateTime @@ -33642,11 +32632,7 @@ type ChannelMetadataUpdated implements Event @doc(category: "Channels") { channel: Channel } -""" -Event sent when new gift card is created. - -Added in Saleor 3.2. -""" +"""Event sent when new gift card is created.""" type GiftCardCreated implements Event @doc(category: "Gift cards") { """Time of the event.""" issuedAt: DateTime @@ -33664,11 +32650,7 @@ type GiftCardCreated implements Event @doc(category: "Gift cards") { giftCard: GiftCard } -""" -Event sent when gift card is updated. - -Added in Saleor 3.2. -""" +"""Event sent when gift card is updated.""" type GiftCardUpdated implements Event @doc(category: "Gift cards") { """Time of the event.""" issuedAt: DateTime @@ -33686,11 +32668,7 @@ type GiftCardUpdated implements Event @doc(category: "Gift cards") { giftCard: GiftCard } -""" -Event sent when gift card is deleted. - -Added in Saleor 3.2. -""" +"""Event sent when gift card is deleted.""" type GiftCardDeleted implements Event @doc(category: "Gift cards") { """Time of the event.""" issuedAt: DateTime @@ -33708,13 +32686,7 @@ type GiftCardDeleted implements Event @doc(category: "Gift cards") { giftCard: GiftCard } -""" -Event sent when gift card is e-mailed. - -Added in Saleor 3.13. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Event sent when gift card is e-mailed.""" type GiftCardSent implements Event @doc(category: "Gift cards") { """Time of the event.""" issuedAt: DateTime @@ -33738,11 +32710,7 @@ type GiftCardSent implements Event @doc(category: "Gift cards") { sentToEmail: String } -""" -Event sent when gift card status has changed. - -Added in Saleor 3.2. -""" +"""Event sent when gift card status has changed.""" type GiftCardStatusChanged implements Event @doc(category: "Gift cards") { """Time of the event.""" issuedAt: DateTime @@ -33760,11 +32728,7 @@ type GiftCardStatusChanged implements Event @doc(category: "Gift cards") { giftCard: GiftCard } -""" -Event sent when gift card metadata is updated. - -Added in Saleor 3.8. -""" +"""Event sent when gift card metadata is updated.""" type GiftCardMetadataUpdated implements Event @doc(category: "Gift cards") { """Time of the event.""" issuedAt: DateTime @@ -33782,11 +32746,7 @@ type GiftCardMetadataUpdated implements Event @doc(category: "Gift cards") { giftCard: GiftCard } -""" -Event sent when gift card export is completed. - -Added in Saleor 3.16. -""" +"""Event sent when gift card export is completed.""" type GiftCardExportCompleted implements Event @doc(category: "Gift cards") { """Time of the event.""" issuedAt: DateTime @@ -33804,11 +32764,7 @@ type GiftCardExportCompleted implements Event @doc(category: "Gift cards") { export: ExportFile } -""" -Event sent when new menu is created. - -Added in Saleor 3.4. -""" +"""Event sent when new menu is created.""" type MenuCreated implements Event @doc(category: "Menu") { """Time of the event.""" issuedAt: DateTime @@ -33829,11 +32785,7 @@ type MenuCreated implements Event @doc(category: "Menu") { ): Menu } -""" -Event sent when menu is updated. - -Added in Saleor 3.4. -""" +"""Event sent when menu is updated.""" type MenuUpdated implements Event @doc(category: "Menu") { """Time of the event.""" issuedAt: DateTime @@ -33852,13 +32804,9 @@ type MenuUpdated implements Event @doc(category: "Menu") { """Slug of a channel for which the data should be returned.""" channel: String ): Menu -} - -""" -Event sent when menu is deleted. +} -Added in Saleor 3.4. -""" +"""Event sent when menu is deleted.""" type MenuDeleted implements Event @doc(category: "Menu") { """Time of the event.""" issuedAt: DateTime @@ -33879,11 +32827,7 @@ type MenuDeleted implements Event @doc(category: "Menu") { ): Menu } -""" -Event sent when new menu item is created. - -Added in Saleor 3.4. -""" +"""Event sent when new menu item is created.""" type MenuItemCreated implements Event @doc(category: "Menu") { """Time of the event.""" issuedAt: DateTime @@ -33904,11 +32848,7 @@ type MenuItemCreated implements Event @doc(category: "Menu") { ): MenuItem } -""" -Event sent when menu item is updated. - -Added in Saleor 3.4. -""" +"""Event sent when menu item is updated.""" type MenuItemUpdated implements Event @doc(category: "Menu") { """Time of the event.""" issuedAt: DateTime @@ -33929,11 +32869,7 @@ type MenuItemUpdated implements Event @doc(category: "Menu") { ): MenuItem } -""" -Event sent when menu item is deleted. - -Added in Saleor 3.4. -""" +"""Event sent when menu item is deleted.""" type MenuItemDeleted implements Event @doc(category: "Menu") { """Time of the event.""" issuedAt: DateTime @@ -33954,11 +32890,7 @@ type MenuItemDeleted implements Event @doc(category: "Menu") { ): MenuItem } -""" -Event sent when new product is created. - -Added in Saleor 3.2. -""" +"""Event sent when new product is created.""" type ProductCreated implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -33982,11 +32914,7 @@ type ProductCreated implements Event @doc(category: "Products") { category: Category } -""" -Event sent when product is updated. - -Added in Saleor 3.2. -""" +"""Event sent when product is updated.""" type ProductUpdated implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -34010,11 +32938,7 @@ type ProductUpdated implements Event @doc(category: "Products") { category: Category } -""" -Event sent when product is deleted. - -Added in Saleor 3.2. -""" +"""Event sent when product is deleted.""" type ProductDeleted implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -34038,11 +32962,7 @@ type ProductDeleted implements Event @doc(category: "Products") { category: Category } -""" -Event sent when product metadata is updated. - -Added in Saleor 3.8. -""" +"""Event sent when product metadata is updated.""" type ProductMetadataUpdated implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -34066,11 +32986,7 @@ type ProductMetadataUpdated implements Event @doc(category: "Products") { category: Category } -""" -Event sent when product export is completed. - -Added in Saleor 3.16. -""" +"""Event sent when product export is completed.""" type ProductExportCompleted implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -34088,11 +33004,7 @@ type ProductExportCompleted implements Event @doc(category: "Products") { export: ExportFile } -""" -Event sent when new product media is created. - -Added in Saleor 3.12. -""" +"""Event sent when new product media is created.""" type ProductMediaCreated implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -34110,11 +33022,7 @@ type ProductMediaCreated implements Event @doc(category: "Products") { productMedia: ProductMedia } -""" -Event sent when product media is updated. - -Added in Saleor 3.12. -""" +"""Event sent when product media is updated.""" type ProductMediaUpdated implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -34132,11 +33040,7 @@ type ProductMediaUpdated implements Event @doc(category: "Products") { productMedia: ProductMedia } -""" -Event sent when product media is deleted. - -Added in Saleor 3.12. -""" +"""Event sent when product media is deleted.""" type ProductMediaDeleted implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -34154,11 +33058,7 @@ type ProductMediaDeleted implements Event @doc(category: "Products") { productMedia: ProductMedia } -""" -Event sent when new product variant is created. - -Added in Saleor 3.2. -""" +"""Event sent when new product variant is created.""" type ProductVariantCreated implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -34179,11 +33079,7 @@ type ProductVariantCreated implements Event @doc(category: "Products") { ): ProductVariant } -""" -Event sent when product variant is updated. - -Added in Saleor 3.2. -""" +"""Event sent when product variant is updated.""" type ProductVariantUpdated implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -34204,11 +33100,7 @@ type ProductVariantUpdated implements Event @doc(category: "Products") { ): ProductVariant } -""" -Event sent when product variant is out of stock. - -Added in Saleor 3.2. -""" +"""Event sent when product variant is out of stock.""" type ProductVariantOutOfStock implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -34232,11 +33124,7 @@ type ProductVariantOutOfStock implements Event @doc(category: "Products") { warehouse: Warehouse } -""" -Event sent when product variant is back in stock. - -Added in Saleor 3.2. -""" +"""Event sent when product variant is back in stock.""" type ProductVariantBackInStock implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -34260,13 +33148,7 @@ type ProductVariantBackInStock implements Event @doc(category: "Products") { warehouse: Warehouse } -""" -Event sent when product variant stock is updated. - -Added in Saleor 3.11. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Event sent when product variant stock is updated.""" type ProductVariantStockUpdated implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -34290,11 +33172,7 @@ type ProductVariantStockUpdated implements Event @doc(category: "Products") { warehouse: Warehouse } -""" -Event sent when product variant is deleted. - -Added in Saleor 3.2. -""" +"""Event sent when product variant is deleted.""" type ProductVariantDeleted implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -34315,11 +33193,7 @@ type ProductVariantDeleted implements Event @doc(category: "Products") { ): ProductVariant } -""" -Event sent when product variant metadata is updated. - -Added in Saleor 3.8. -""" +"""Event sent when product variant metadata is updated.""" type ProductVariantMetadataUpdated implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -34343,9 +33217,7 @@ type ProductVariantMetadataUpdated implements Event @doc(category: "Products") { """ Event sent when new sale is created. -Added in Saleor 3.2. - -DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionCreated` event instead. +DEPRECATED: this event will be removed. Use `PromotionCreated` event instead. """ type SaleCreated implements Event @doc(category: "Discounts") { """Time of the event.""" @@ -34370,9 +33242,7 @@ type SaleCreated implements Event @doc(category: "Discounts") { """ Event sent when sale is updated. -Added in Saleor 3.2. - -DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionUpdated` event instead. +DEPRECATED: this event will be removed. Use `PromotionUpdated` event instead. """ type SaleUpdated implements Event @doc(category: "Discounts") { """Time of the event.""" @@ -34397,9 +33267,7 @@ type SaleUpdated implements Event @doc(category: "Discounts") { """ Event sent when sale is deleted. -Added in Saleor 3.2. - -DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionDeleted` event instead. +DEPRECATED: this event will be removed. Use `PromotionDeleted` event instead. """ type SaleDeleted implements Event @doc(category: "Discounts") { """Time of the event.""" @@ -34424,9 +33292,7 @@ type SaleDeleted implements Event @doc(category: "Discounts") { """ The event informs about the start or end of the sale. -Added in Saleor 3.5. - -DEPRECATED: this event will be removed in Saleor 4.0. Use `PromotionStarted` and `PromotionEnded` events instead. +DEPRECATED: this event will be removed. Use `PromotionStarted` and `PromotionEnded` events instead. """ type SaleToggle implements Event @doc(category: "Discounts") { """Time of the event.""" @@ -34441,24 +33307,14 @@ type SaleToggle implements Event @doc(category: "Discounts") { """The application receiving the webhook.""" recipient: App - """ - The sale the event relates to. - - Added in Saleor 3.5. - """ + """The sale the event relates to.""" sale( """Slug of a channel for which the data should be returned.""" channel: String ): Sale } -""" -Event sent when new promotion is created. - -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Event sent when new promotion is created.""" type PromotionCreated implements Event @doc(category: "Discounts") { """Time of the event.""" issuedAt: DateTime @@ -34476,13 +33332,7 @@ type PromotionCreated implements Event @doc(category: "Discounts") { promotion: Promotion } -""" -Event sent when promotion is updated. - -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Event sent when promotion is updated.""" type PromotionUpdated implements Event @doc(category: "Discounts") { """Time of the event.""" issuedAt: DateTime @@ -34500,13 +33350,7 @@ type PromotionUpdated implements Event @doc(category: "Discounts") { promotion: Promotion } -""" -Event sent when promotion is deleted. - -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Event sent when promotion is deleted.""" type PromotionDeleted implements Event @doc(category: "Discounts") { """Time of the event.""" issuedAt: DateTime @@ -34524,13 +33368,7 @@ type PromotionDeleted implements Event @doc(category: "Discounts") { promotion: Promotion } -""" -The event informs about the start of the promotion. - -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""The event informs about the start of the promotion.""" type PromotionStarted implements Event @doc(category: "Discounts") { """Time of the event.""" issuedAt: DateTime @@ -34548,13 +33386,7 @@ type PromotionStarted implements Event @doc(category: "Discounts") { promotion: Promotion } -""" -The event informs about the end of the promotion. - -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""The event informs about the end of the promotion.""" type PromotionEnded implements Event @doc(category: "Discounts") { """Time of the event.""" issuedAt: DateTime @@ -34572,13 +33404,7 @@ type PromotionEnded implements Event @doc(category: "Discounts") { promotion: Promotion } -""" -Event sent when new promotion rule is created. - -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Event sent when new promotion rule is created.""" type PromotionRuleCreated implements Event @doc(category: "Discounts") { """Time of the event.""" issuedAt: DateTime @@ -34596,13 +33422,7 @@ type PromotionRuleCreated implements Event @doc(category: "Discounts") { promotionRule: PromotionRule } -""" -Event sent when new promotion rule is updated. - -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Event sent when new promotion rule is updated.""" type PromotionRuleUpdated implements Event @doc(category: "Discounts") { """Time of the event.""" issuedAt: DateTime @@ -34620,13 +33440,7 @@ type PromotionRuleUpdated implements Event @doc(category: "Discounts") { promotionRule: PromotionRule } -""" -Event sent when new promotion rule is deleted. - -Added in Saleor 3.17. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Event sent when new promotion rule is deleted.""" type PromotionRuleDeleted implements Event @doc(category: "Discounts") { """Time of the event.""" issuedAt: DateTime @@ -34644,11 +33458,7 @@ type PromotionRuleDeleted implements Event @doc(category: "Discounts") { promotionRule: PromotionRule } -""" -Event sent when invoice is requested. - -Added in Saleor 3.2. -""" +"""Event sent when invoice is requested.""" type InvoiceRequested implements Event @doc(category: "Orders") { """Time of the event.""" issuedAt: DateTime @@ -34665,19 +33475,11 @@ type InvoiceRequested implements Event @doc(category: "Orders") { """The invoice the event relates to.""" invoice: Invoice - """ - Order related to the invoice. - - Added in Saleor 3.10. - """ + """Order related to the invoice.""" order: Order! } -""" -Event sent when invoice is deleted. - -Added in Saleor 3.2. -""" +"""Event sent when invoice is deleted.""" type InvoiceDeleted implements Event @doc(category: "Orders") { """Time of the event.""" issuedAt: DateTime @@ -34694,19 +33496,11 @@ type InvoiceDeleted implements Event @doc(category: "Orders") { """The invoice the event relates to.""" invoice: Invoice - """ - Order related to the invoice. - - Added in Saleor 3.10. - """ + """Order related to the invoice.""" order: Order } -""" -Event sent when invoice is sent. - -Added in Saleor 3.2. -""" +"""Event sent when invoice is sent.""" type InvoiceSent implements Event @doc(category: "Orders") { """Time of the event.""" issuedAt: DateTime @@ -34723,19 +33517,11 @@ type InvoiceSent implements Event @doc(category: "Orders") { """The invoice the event relates to.""" invoice: Invoice - """ - Order related to the invoice. - - Added in Saleor 3.10. - """ + """Order related to the invoice.""" order: Order } -""" -Event sent when new fulfillment is created. - -Added in Saleor 3.4. -""" +"""Event sent when new fulfillment is created.""" type FulfillmentCreated implements Event @doc(category: "Orders") { """Time of the event.""" issuedAt: DateTime @@ -34755,19 +33541,11 @@ type FulfillmentCreated implements Event @doc(category: "Orders") { """The order the fulfillment belongs to.""" order: Order - """ - If true, the app should send a notification to the customer. - - Added in Saleor 3.16. - """ + """If true, the app should send a notification to the customer.""" notifyCustomer: Boolean! } -""" -Event sent when the tracking number is updated. - -Added in Saleor 3.16. -""" +"""Event sent when the tracking number is updated.""" type FulfillmentTrackingNumberUpdated implements Event @doc(category: "Orders") { """Time of the event.""" issuedAt: DateTime @@ -34788,11 +33566,7 @@ type FulfillmentTrackingNumberUpdated implements Event @doc(category: "Orders") order: Order } -""" -Event sent when fulfillment is canceled. - -Added in Saleor 3.4. -""" +"""Event sent when fulfillment is canceled.""" type FulfillmentCanceled implements Event @doc(category: "Orders") { """Time of the event.""" issuedAt: DateTime @@ -34813,11 +33587,7 @@ type FulfillmentCanceled implements Event @doc(category: "Orders") { order: Order } -""" -Event sent when fulfillment is approved. - -Added in Saleor 3.7. -""" +"""Event sent when fulfillment is approved.""" type FulfillmentApproved implements Event @doc(category: "Orders") { """Time of the event.""" issuedAt: DateTime @@ -34837,19 +33607,11 @@ type FulfillmentApproved implements Event @doc(category: "Orders") { """The order the fulfillment belongs to.""" order: Order - """ - If true, send a notification to the customer. - - Added in Saleor 3.16. - """ + """If true, send a notification to the customer.""" notifyCustomer: Boolean! } -""" -Event sent when fulfillment metadata is updated. - -Added in Saleor 3.8. -""" +"""Event sent when fulfillment metadata is updated.""" type FulfillmentMetadataUpdated implements Event @doc(category: "Orders") { """Time of the event.""" issuedAt: DateTime @@ -34870,11 +33632,7 @@ type FulfillmentMetadataUpdated implements Event @doc(category: "Orders") { order: Order } -""" -Event sent when new customer user is created. - -Added in Saleor 3.2. -""" +"""Event sent when new customer user is created.""" type CustomerCreated implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -34892,11 +33650,7 @@ type CustomerCreated implements Event @doc(category: "Users") { user: User } -""" -Event sent when customer user is updated. - -Added in Saleor 3.2. -""" +"""Event sent when customer user is updated.""" type CustomerUpdated implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -34914,11 +33668,7 @@ type CustomerUpdated implements Event @doc(category: "Users") { user: User } -""" -Event sent when customer user metadata is updated. - -Added in Saleor 3.8. -""" +"""Event sent when customer user metadata is updated.""" type CustomerMetadataUpdated implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -34936,11 +33686,7 @@ type CustomerMetadataUpdated implements Event @doc(category: "Users") { user: User } -""" -Event sent when new collection is created. - -Added in Saleor 3.2. -""" +"""Event sent when new collection is created.""" type CollectionCreated implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -34961,11 +33707,7 @@ type CollectionCreated implements Event @doc(category: "Products") { ): Collection } -""" -Event sent when collection is updated. - -Added in Saleor 3.2. -""" +"""Event sent when collection is updated.""" type CollectionUpdated implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -34986,11 +33728,7 @@ type CollectionUpdated implements Event @doc(category: "Products") { ): Collection } -""" -Event sent when collection is deleted. - -Added in Saleor 3.2. -""" +"""Event sent when collection is deleted.""" type CollectionDeleted implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -35011,11 +33749,7 @@ type CollectionDeleted implements Event @doc(category: "Products") { ): Collection } -""" -Event sent when collection metadata is updated. - -Added in Saleor 3.8. -""" +"""Event sent when collection metadata is updated.""" type CollectionMetadataUpdated implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -35036,101 +33770,7 @@ type CollectionMetadataUpdated implements Event @doc(category: "Products") { ): Collection } -""" -Event sent when new checkout is created. - -Added in Saleor 3.2. -""" -type CheckoutCreated implements Event @doc(category: "Checkout") { - """Time of the event.""" - issuedAt: DateTime - - """Saleor version that triggered the event.""" - version: String - - """The user or application that triggered the event.""" - issuingPrincipal: IssuingPrincipal - - """The application receiving the webhook.""" - recipient: App - - """The checkout the event relates to.""" - checkout: Checkout -} - -""" -Event sent when checkout is updated. - -Added in Saleor 3.2. -""" -type CheckoutUpdated implements Event @doc(category: "Checkout") { - """Time of the event.""" - issuedAt: DateTime - - """Saleor version that triggered the event.""" - version: String - - """The user or application that triggered the event.""" - issuingPrincipal: IssuingPrincipal - - """The application receiving the webhook.""" - recipient: App - - """The checkout the event relates to.""" - checkout: Checkout -} - -""" -Event sent when checkout is fully paid with transactions. - -Added in Saleor 3.13. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" -type CheckoutFullyPaid implements Event @doc(category: "Checkout") { - """Time of the event.""" - issuedAt: DateTime - - """Saleor version that triggered the event.""" - version: String - - """The user or application that triggered the event.""" - issuingPrincipal: IssuingPrincipal - - """The application receiving the webhook.""" - recipient: App - - """The checkout the event relates to.""" - checkout: Checkout -} - -""" -Event sent when checkout metadata is updated. - -Added in Saleor 3.8. -""" -type CheckoutMetadataUpdated implements Event @doc(category: "Checkout") { - """Time of the event.""" - issuedAt: DateTime - - """Saleor version that triggered the event.""" - version: String - - """The user or application that triggered the event.""" - issuingPrincipal: IssuingPrincipal - - """The application receiving the webhook.""" - recipient: App - - """The checkout the event relates to.""" - checkout: Checkout -} - -""" -Event sent when new page is created. - -Added in Saleor 3.2. -""" +"""Event sent when new page is created.""" type PageCreated implements Event @doc(category: "Pages") { """Time of the event.""" issuedAt: DateTime @@ -35148,11 +33788,7 @@ type PageCreated implements Event @doc(category: "Pages") { page: Page } -""" -Event sent when page is updated. - -Added in Saleor 3.2. -""" +"""Event sent when page is updated.""" type PageUpdated implements Event @doc(category: "Pages") { """Time of the event.""" issuedAt: DateTime @@ -35170,11 +33806,7 @@ type PageUpdated implements Event @doc(category: "Pages") { page: Page } -""" -Event sent when page is deleted. - -Added in Saleor 3.2. -""" +"""Event sent when page is deleted.""" type PageDeleted implements Event @doc(category: "Pages") { """Time of the event.""" issuedAt: DateTime @@ -35192,11 +33824,7 @@ type PageDeleted implements Event @doc(category: "Pages") { page: Page } -""" -Event sent when new page type is created. - -Added in Saleor 3.5. -""" +"""Event sent when new page type is created.""" type PageTypeCreated implements Event @doc(category: "Pages") { """Time of the event.""" issuedAt: DateTime @@ -35214,11 +33842,7 @@ type PageTypeCreated implements Event @doc(category: "Pages") { pageType: PageType } -""" -Event sent when page type is updated. - -Added in Saleor 3.5. -""" +"""Event sent when page type is updated.""" type PageTypeUpdated implements Event @doc(category: "Pages") { """Time of the event.""" issuedAt: DateTime @@ -35236,11 +33860,7 @@ type PageTypeUpdated implements Event @doc(category: "Pages") { pageType: PageType } -""" -Event sent when page type is deleted. - -Added in Saleor 3.5. -""" +"""Event sent when page type is deleted.""" type PageTypeDeleted implements Event @doc(category: "Pages") { """Time of the event.""" issuedAt: DateTime @@ -35258,11 +33878,7 @@ type PageTypeDeleted implements Event @doc(category: "Pages") { pageType: PageType } -""" -Event sent when new permission group is created. - -Added in Saleor 3.6. -""" +"""Event sent when new permission group is created.""" type PermissionGroupCreated implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -35280,11 +33896,7 @@ type PermissionGroupCreated implements Event @doc(category: "Users") { permissionGroup: Group } -""" -Event sent when permission group is updated. - -Added in Saleor 3.6. -""" +"""Event sent when permission group is updated.""" type PermissionGroupUpdated implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -35302,11 +33914,7 @@ type PermissionGroupUpdated implements Event @doc(category: "Users") { permissionGroup: Group } -""" -Event sent when permission group is deleted. - -Added in Saleor 3.6. -""" +"""Event sent when permission group is deleted.""" type PermissionGroupDeleted implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -35324,11 +33932,7 @@ type PermissionGroupDeleted implements Event @doc(category: "Users") { permissionGroup: Group } -""" -Event sent when new shipping price is created. - -Added in Saleor 3.2. -""" +"""Event sent when new shipping price is created.""" type ShippingPriceCreated implements Event @doc(category: "Shipping") { """Time of the event.""" issuedAt: DateTime @@ -35355,11 +33959,7 @@ type ShippingPriceCreated implements Event @doc(category: "Shipping") { ): ShippingZone } -""" -Event sent when shipping price is updated. - -Added in Saleor 3.2. -""" +"""Event sent when shipping price is updated.""" type ShippingPriceUpdated implements Event @doc(category: "Shipping") { """Time of the event.""" issuedAt: DateTime @@ -35386,11 +33986,7 @@ type ShippingPriceUpdated implements Event @doc(category: "Shipping") { ): ShippingZone } -""" -Event sent when shipping price is deleted. - -Added in Saleor 3.2. -""" +"""Event sent when shipping price is deleted.""" type ShippingPriceDeleted implements Event @doc(category: "Shipping") { """Time of the event.""" issuedAt: DateTime @@ -35417,11 +34013,7 @@ type ShippingPriceDeleted implements Event @doc(category: "Shipping") { ): ShippingZone } -""" -Event sent when new shipping zone is created. - -Added in Saleor 3.2. -""" +"""Event sent when new shipping zone is created.""" type ShippingZoneCreated implements Event @doc(category: "Shipping") { """Time of the event.""" issuedAt: DateTime @@ -35442,11 +34034,7 @@ type ShippingZoneCreated implements Event @doc(category: "Shipping") { ): ShippingZone } -""" -Event sent when shipping zone is updated. - -Added in Saleor 3.2. -""" +"""Event sent when shipping zone is updated.""" type ShippingZoneUpdated implements Event @doc(category: "Shipping") { """Time of the event.""" issuedAt: DateTime @@ -35467,11 +34055,7 @@ type ShippingZoneUpdated implements Event @doc(category: "Shipping") { ): ShippingZone } -""" -Event sent when shipping zone is deleted. - -Added in Saleor 3.2. -""" +"""Event sent when shipping zone is deleted.""" type ShippingZoneDeleted implements Event @doc(category: "Shipping") { """Time of the event.""" issuedAt: DateTime @@ -35492,11 +34076,7 @@ type ShippingZoneDeleted implements Event @doc(category: "Shipping") { ): ShippingZone } -""" -Event sent when shipping zone metadata is updated. - -Added in Saleor 3.8. -""" +"""Event sent when shipping zone metadata is updated.""" type ShippingZoneMetadataUpdated implements Event @doc(category: "Shipping") { """Time of the event.""" issuedAt: DateTime @@ -35517,11 +34097,7 @@ type ShippingZoneMetadataUpdated implements Event @doc(category: "Shipping") { ): ShippingZone } -""" -Event sent when shop metadata is updated. - -Added in Saleor 3.15. -""" +"""Event sent when shop metadata is updated.""" type ShopMetadataUpdated implements Event { """Time of the event.""" issuedAt: DateTime @@ -35539,11 +34115,7 @@ type ShopMetadataUpdated implements Event { shop: Shop } -""" -Event sent when new staff user is created. - -Added in Saleor 3.5. -""" +"""Event sent when new staff user is created.""" type StaffCreated implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -35561,11 +34133,7 @@ type StaffCreated implements Event @doc(category: "Users") { user: User } -""" -Event sent when staff user is updated. - -Added in Saleor 3.5. -""" +"""Event sent when staff user is updated.""" type StaffUpdated implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -35583,11 +34151,7 @@ type StaffUpdated implements Event @doc(category: "Users") { user: User } -""" -Event sent when staff user is deleted. - -Added in Saleor 3.5. -""" +"""Event sent when staff user is deleted.""" type StaffDeleted implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -35605,11 +34169,7 @@ type StaffDeleted implements Event @doc(category: "Users") { user: User } -""" -Event sent when setting a new password for staff is requested. - -Added in Saleor 3.15. -""" +"""Event sent when setting a new password for staff is requested.""" type StaffSetPasswordRequested implements Event @doc(category: "Users") { """Time of the event.""" issuedAt: DateTime @@ -35639,11 +34199,7 @@ type StaffSetPasswordRequested implements Event @doc(category: "Users") { shop: Shop } -""" -Event sent when transaction item metadata is updated. - -Added in Saleor 3.8. -""" +"""Event sent when transaction item metadata is updated.""" type TransactionItemMetadataUpdated implements Event @doc(category: "Payments") { """Time of the event.""" issuedAt: DateTime @@ -35661,11 +34217,7 @@ type TransactionItemMetadataUpdated implements Event @doc(category: "Payments") transaction: TransactionItem } -""" -Event sent when new translation is created. - -Added in Saleor 3.2. -""" +"""Event sent when new translation is created.""" type TranslationCreated implements Event @doc(category: "Miscellaneous") { """Time of the event.""" issuedAt: DateTime @@ -35685,11 +34237,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. - -Added in Saleor 3.2. -""" +"""Event sent when translation is updated.""" type TranslationUpdated implements Event @doc(category: "Miscellaneous") { """Time of the event.""" issuedAt: DateTime @@ -35707,11 +34255,7 @@ type TranslationUpdated implements Event @doc(category: "Miscellaneous") { translation: TranslationTypes } -""" -Event sent when new voucher is created. - -Added in Saleor 3.4. -""" +"""Event sent when new voucher is created.""" type VoucherCreated implements Event @doc(category: "Discounts") { """Time of the event.""" issuedAt: DateTime @@ -35732,11 +34276,7 @@ type VoucherCreated implements Event @doc(category: "Discounts") { ): Voucher } -""" -Event sent when voucher is updated. - -Added in Saleor 3.4. -""" +"""Event sent when voucher is updated.""" type VoucherUpdated implements Event @doc(category: "Discounts") { """Time of the event.""" issuedAt: DateTime @@ -35757,11 +34297,7 @@ type VoucherUpdated implements Event @doc(category: "Discounts") { ): Voucher } -""" -Event sent when voucher is deleted. - -Added in Saleor 3.4. -""" +"""Event sent when voucher is deleted.""" type VoucherDeleted implements Event @doc(category: "Discounts") { """Time of the event.""" issuedAt: DateTime @@ -35826,11 +34362,7 @@ type VoucherCodesDeleted implements Event { voucherCodes: [VoucherCode!] } -""" -Event sent when voucher metadata is updated. - -Added in Saleor 3.8. -""" +"""Event sent when voucher metadata is updated.""" type VoucherMetadataUpdated implements Event @doc(category: "Discounts") { """Time of the event.""" issuedAt: DateTime @@ -35873,11 +34405,7 @@ type VoucherCodeExportCompleted implements Event @doc(category: "Discounts") { export: ExportFile } -""" -Event sent when new warehouse is created. - -Added in Saleor 3.4. -""" +"""Event sent when new warehouse is created.""" type WarehouseCreated implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -35895,11 +34423,7 @@ type WarehouseCreated implements Event @doc(category: "Products") { warehouse: Warehouse } -""" -Event sent when warehouse is updated. - -Added in Saleor 3.4. -""" +"""Event sent when warehouse is updated.""" type WarehouseUpdated implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -35917,11 +34441,7 @@ type WarehouseUpdated implements Event @doc(category: "Products") { warehouse: Warehouse } -""" -Event sent when warehouse is deleted. - -Added in Saleor 3.4. -""" +"""Event sent when warehouse is deleted.""" type WarehouseDeleted implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -35939,11 +34459,7 @@ type WarehouseDeleted implements Event @doc(category: "Products") { warehouse: Warehouse } -""" -Event sent when warehouse metadata is updated. - -Added in Saleor 3.8. -""" +"""Event sent when warehouse metadata is updated.""" type WarehouseMetadataUpdated implements Event @doc(category: "Products") { """Time of the event.""" issuedAt: DateTime @@ -35961,11 +34477,7 @@ type WarehouseMetadataUpdated implements Event @doc(category: "Products") { warehouse: Warehouse } -""" -Event sent when thumbnail is created. - -Added in Saleor 3.12. -""" +"""Event sent when thumbnail is created.""" type ThumbnailCreated implements Event @doc(category: "Miscellaneous") { """Time of the event.""" issuedAt: DateTime @@ -35979,40 +34491,20 @@ type ThumbnailCreated implements Event @doc(category: "Miscellaneous") { """The application receiving the webhook.""" recipient: App - """ - Thumbnail id. - - Added in Saleor 3.12. - """ + """Thumbnail id.""" id: ID - """ - Thumbnail url. - - Added in Saleor 3.12. - """ + """Thumbnail url.""" url: String - """ - Object the thumbnail refers to. - - Added in Saleor 3.12. - """ + """Object the thumbnail refers to.""" objectId: ID - """ - Original media url. - - Added in Saleor 3.12. - """ + """Original media url.""" mediaUrl: String } -""" -Authorize payment. - -Added in Saleor 3.6. -""" +"""Authorize payment.""" type PaymentAuthorize implements Event @doc(category: "Payments") { """Time of the event.""" issuedAt: DateTime @@ -36030,11 +34522,7 @@ type PaymentAuthorize implements Event @doc(category: "Payments") { payment: Payment } -""" -Capture payment. - -Added in Saleor 3.6. -""" +"""Capture payment.""" type PaymentCaptureEvent implements Event @doc(category: "Payments") { """Time of the event.""" issuedAt: DateTime @@ -36052,11 +34540,7 @@ type PaymentCaptureEvent implements Event @doc(category: "Payments") { payment: Payment } -""" -Refund payment. - -Added in Saleor 3.6. -""" +"""Refund payment.""" type PaymentRefundEvent implements Event @doc(category: "Payments") { """Time of the event.""" issuedAt: DateTime @@ -36074,11 +34558,7 @@ type PaymentRefundEvent implements Event @doc(category: "Payments") { payment: Payment } -""" -Void payment. - -Added in Saleor 3.6. -""" +"""Void payment.""" type PaymentVoidEvent implements Event @doc(category: "Payments") { """Time of the event.""" issuedAt: DateTime @@ -36096,11 +34576,7 @@ type PaymentVoidEvent implements Event @doc(category: "Payments") { payment: Payment } -""" -Confirm payment. - -Added in Saleor 3.6. -""" +"""Confirm payment.""" type PaymentConfirmEvent implements Event @doc(category: "Payments") { """Time of the event.""" issuedAt: DateTime @@ -36118,11 +34594,7 @@ type PaymentConfirmEvent implements Event @doc(category: "Payments") { payment: Payment } -""" -Process payment. - -Added in Saleor 3.6. -""" +"""Process payment.""" type PaymentProcessEvent implements Event @doc(category: "Payments") { """Time of the event.""" issuedAt: DateTime @@ -36140,11 +34612,7 @@ type PaymentProcessEvent implements Event @doc(category: "Payments") { payment: Payment } -""" -List payment gateways. - -Added in Saleor 3.6. -""" +"""List payment gateways.""" type PaymentListGateways implements Event @doc(category: "Payments") { """Time of the event.""" issuedAt: DateTime @@ -36162,13 +34630,7 @@ type PaymentListGateways implements Event @doc(category: "Payments") { checkout: Checkout } -""" -Event sent when transaction cancelation is requested. - -Added in Saleor 3.13. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Event sent when transaction cancelation is requested.""" type TransactionCancelationRequested implements Event @doc(category: "Payments") { """Time of the event.""" issuedAt: DateTime @@ -36193,24 +34655,14 @@ type TransactionAction @doc(category: "Payments") { """Determines the action type.""" actionType: TransactionActionEnum! - """Transaction request amount. Null when action type is VOID.""" - amount: PositiveDecimal + """Transaction request amount.""" + amount: PositiveDecimal! - """ - Currency code. - - Added in Saleor 3.16. - """ + """Currency code.""" currency: String! } -""" -Event sent when transaction charge is requested. - -Added in Saleor 3.13. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Event sent when transaction charge is requested.""" type TransactionChargeRequested implements Event @doc(category: "Payments") { """Time of the event.""" issuedAt: DateTime @@ -36231,13 +34683,7 @@ type TransactionChargeRequested implements Event @doc(category: "Payments") { action: TransactionAction! } -""" -Event sent when transaction refund is requested. - -Added in Saleor 3.13. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Event sent when transaction refund is requested.""" type TransactionRefundRequested implements Event @doc(category: "Payments") { """Time of the event.""" issuedAt: DateTime @@ -36259,19 +34705,13 @@ type TransactionRefundRequested implements Event @doc(category: "Payments") { """ Granted refund related to refund request. - - Added in Saleor 3.15. - + Note: this API is currently in Feature Preview and can be subject to changes at later point. """ grantedRefund: OrderGrantedRefund } -""" -Filter shipping methods for order. - -Added in Saleor 3.6. -""" +"""Filter shipping methods for order.""" type OrderFilterShippingMethods implements Event @doc(category: "Orders") { """Time of the event.""" issuedAt: DateTime @@ -36288,19 +34728,11 @@ type OrderFilterShippingMethods implements Event @doc(category: "Orders") { """The order the event relates to.""" order: Order - """ - Shipping methods that can be used with this checkout. - - Added in Saleor 3.6. - """ + """Shipping methods that can be used with this checkout.""" shippingMethods: [ShippingMethod!] } -""" -Filter shipping methods for checkout. - -Added in Saleor 3.6. -""" +"""Filter shipping methods for checkout.""" type CheckoutFilterShippingMethods implements Event @doc(category: "Checkout") { """Time of the event.""" issuedAt: DateTime @@ -36315,153 +34747,34 @@ type CheckoutFilterShippingMethods implements Event @doc(category: "Checkout") { recipient: App """The checkout the event relates to.""" - checkout: Checkout - - """ - Shipping methods that can be used with this checkout. - - Added in Saleor 3.6. - """ - shippingMethods: [ShippingMethod!] -} - -""" -List shipping methods for checkout. - -Added in Saleor 3.6. -""" -type ShippingListMethodsForCheckout implements Event @doc(category: "Checkout") { - """Time of the event.""" - issuedAt: DateTime - - """Saleor version that triggered the event.""" - version: String - - """The user or application that triggered the event.""" - issuingPrincipal: IssuingPrincipal - - """The application receiving the webhook.""" - recipient: App - - """The checkout the event relates to.""" - checkout: Checkout - - """ - Shipping methods that can be used with this checkout. - - Added in Saleor 3.6. - """ - shippingMethods: [ShippingMethod!] -} - -""" -Synchronous webhook for calculating checkout/order taxes. - -Added in Saleor 3.7. -""" -type CalculateTaxes implements Event @doc(category: "Taxes") { - """Time of the event.""" - issuedAt: DateTime - - """Saleor version that triggered the event.""" - version: String - - """The user or application that triggered the event.""" - issuingPrincipal: IssuingPrincipal - - """The application receiving the webhook.""" - recipient: App - taxBase: TaxableObject! -} - -"""Taxable object.""" -type TaxableObject @doc(category: "Taxes") { - """The source object related to this tax object.""" - sourceObject: TaxSourceObject! - - """Determines if prices contain entered tax..""" - pricesEnteredWithTax: Boolean! - - """The currency of the object.""" - currency: String! - - """ - The price of shipping method, includes shipping voucher discount if applied. - """ - shippingPrice: Money! - - """The address data.""" - address: Address - - """List of discounts.""" - discounts: [TaxableObjectDiscount!]! - - """List of lines assigned to the object.""" - lines: [TaxableObjectLine!]! - channel: Channel! -} - -"""Taxable object discount.""" -type TaxableObjectDiscount @doc(category: "Taxes") { - """The name of the discount.""" - name: String - - """The amount of the discount.""" - amount: Money! - - """ - Indicates which part of the order the discount should affect: SUBTOTAL or SHIPPING. - """ - type: TaxableObjectDiscountTypeEnum! -} - -""" -Indicates which part of the order the discount should affect: SUBTOTAL or SHIPPING. -""" -enum TaxableObjectDiscountTypeEnum @doc(category: "Taxes") { - SUBTOTAL - SHIPPING -} - -type TaxableObjectLine @doc(category: "Taxes") { - """The source line related to this tax line.""" - sourceLine: TaxSourceLine! - - """Number of items.""" - quantity: Int! - - """Determines if taxes are being charged for the product.""" - chargeTaxes: Boolean! - - """The product name.""" - productName: String! + checkout: Checkout - """The variant name.""" - variantName: String! + """Shipping methods that can be used with this checkout.""" + shippingMethods: [ShippingMethod!] +} - """The product sku.""" - productSku: String +"""List shipping methods for checkout.""" +type ShippingListMethodsForCheckout implements Event @doc(category: "Checkout") { + """Time of the event.""" + issuedAt: DateTime - """ - Price of the single item in the order line. The price includes catalogue promotions, specific product and applied once per order voucher discounts. The price does not include the entire order discount. - """ - unitPrice: Money! + """Saleor version that triggered the event.""" + version: String - """ - Price of the order line. The price includes catalogue promotions, specific product and applied once per order voucher discounts. The price does not include the entire order discount. - """ - totalPrice: Money! -} + """The user or application that triggered the event.""" + issuingPrincipal: IssuingPrincipal -union TaxSourceLine = CheckoutLine | OrderLine + """The application receiving the webhook.""" + recipient: App -""" -Event sent when user wants to initialize the payment gateway. + """The checkout the event relates to.""" + checkout: Checkout -Added in Saleor 3.13. + """Shipping methods that can be used with this checkout.""" + shippingMethods: [ShippingMethod!] +} -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Event sent when user wants to initialize the payment gateway.""" type PaymentGatewayInitializeSession implements Event @doc(category: "Payments") { """Time of the event.""" issuedAt: DateTime @@ -36487,13 +34800,7 @@ type PaymentGatewayInitializeSession implements Event @doc(category: "Payments") union OrderOrCheckout = Checkout | Order -""" -Event sent when user starts processing the payment. - -Added in Saleor 3.13. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Event sent when user starts processing the payment.""" type TransactionInitializeSession implements Event @doc(category: "Payments") { """Time of the event.""" issuedAt: DateTime @@ -36521,19 +34828,13 @@ type TransactionInitializeSession implements Event @doc(category: "Payments") { """ The customer's IP address. If not provided as a parameter in the mutation, Saleor will try to determine the customer's IP address on its own. - - Added in Saleor 3.16. """ customerIpAddress: String """Action to proceed for the transaction""" action: TransactionProcessAction! - """ - Idempotency key assigned to the transaction initialize. - - Added in Saleor 3.14. - """ + """Idempotency key assigned to the transaction initialize.""" idempotencyKey: String! } @@ -36546,13 +34847,7 @@ type TransactionProcessAction @doc(category: "Payments") { actionType: TransactionFlowStrategyEnum! } -""" -Event sent when user has additional payment action to process. - -Added in Saleor 3.13. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Event sent when user has additional payment action to process.""" type TransactionProcessSession implements Event @doc(category: "Payments") { """Time of the event.""" issuedAt: DateTime @@ -36580,8 +34875,6 @@ type TransactionProcessSession implements Event @doc(category: "Payments") { """ The customer's IP address. If not provided as a parameter in the mutation, Saleor will try to determine the customer's IP address on its own. - - Added in Saleor 3.16. """ customerIpAddress: String @@ -36592,8 +34885,6 @@ type TransactionProcessSession implements Event @doc(category: "Payments") { """ List payment methods stored for the user by payment gateway. -Added in Saleor 3.15. - Note: this API is currently in Feature Preview and can be subject to changes at later point. """ type ListStoredPaymentMethods implements Event @doc(category: "Payments") { @@ -36618,13 +34909,7 @@ type ListStoredPaymentMethods implements Event @doc(category: "Payments") { channel: Channel! } -""" -Event sent when user requests to delete a payment method. - -Added in Saleor 3.16. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Event sent when user requests to delete a payment method.""" type StoredPaymentMethodDeleteRequested implements Event @doc(category: "Payments") { """Time of the event.""" issuedAt: DateTime @@ -36653,11 +34938,7 @@ type StoredPaymentMethodDeleteRequested implements Event @doc(category: "Payment } """ -Event sent to initialize a new session in payment gateway to store the payment method. - -Added in Saleor 3.16. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. +Event sent to initialize a new session in payment gateway to store the payment method. """ type PaymentGatewayInitializeTokenizationSession implements Event @doc(category: "Payments") { """Time of the event.""" @@ -36682,13 +34963,7 @@ type PaymentGatewayInitializeTokenizationSession implements Event @doc(category: data: JSON } -""" -Event sent when user requests a tokenization of payment method. - -Added in Saleor 3.16. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Event sent when user requests a tokenization of payment method.""" type PaymentMethodInitializeTokenizationSession implements Event @doc(category: "Payments") { """Time of the event.""" issuedAt: DateTime @@ -36715,13 +34990,7 @@ type PaymentMethodInitializeTokenizationSession implements Event @doc(category: paymentFlowToSupport: TokenizedPaymentFlowEnum! } -""" -Event sent when user continues a tokenization of payment method. - -Added in Saleor 3.16. - -Note: this API is currently in Feature Preview and can be subject to changes at later point. -""" +"""Event sent when user continues a tokenization of payment method.""" type PaymentMethodProcessTokenizationSession implements Event @doc(category: "Payments") { """Time of the event.""" issuedAt: DateTime @@ -36750,11 +35019,367 @@ type PaymentMethodProcessTokenizationSession implements Event @doc(category: "Pa id: String! } +""" +Represents a card payment method used for a transaction. + +Added in Saleor 3.22. +""" +type CardPaymentMethodDetails implements PaymentMethodDetails { + """Name of the payment method.""" + name: String! + + """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 a payment method used for a transaction. + +Added in Saleor 3.22. +""" +type OtherPaymentMethodDetails implements PaymentMethodDetails { + """Name of the payment method.""" + name: String! +} + +""" +Represents a numeric value of an attribute. + +Added in Saleor 3.22. +""" +type AssignedNumericAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """The assigned numeric value.""" + value: Float +} + +""" +Represents text attribute. + +Added in Saleor 3.22. +""" +type AssignedTextAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """The assigned rich text content.""" + value: JSON + + """Translation of the rich text content in the specified language.""" + translation(languageCode: LanguageCodeEnum!): JSON +} + +""" +Represents plain text attribute. + +Added in Saleor 3.22. +""" +type AssignedPlainTextAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """The assigned plain text content.""" + value: String + + """Translation of the plain text content in the specified language.""" + translation(languageCode: LanguageCodeEnum!): String +} + +""" +Represents file attribute. + +Added in Saleor 3.22. +""" +type AssignedFileAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """The assigned file.""" + value: File +} + +""" +Represents a single choice attribute. + +Added in Saleor 3.22. +""" +type AssignedSingleChoiceAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """The assigned choice value.""" + value: AssignedChoiceAttributeValue +} + +""" +Represents a single choice value of the attribute. + +Added in Saleor 3.22. +""" +type AssignedChoiceAttributeValue @doc(category: "Attributes") { + """Name of a value displayed in the interface.""" + name: String + + """Internal representation of a value (unique per attribute).""" + slug: String + + """Translation of the name.""" + translation(languageCode: LanguageCodeEnum!): String +} + +""" +Represents a multi choice attribute. + +Added in Saleor 3.22. +""" +type AssignedMultiChoiceAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """List of assigned choice values.""" + value( + """Maximum number of choices to return. Default is 100.""" + limit: PositiveInt = 100 + ): [AssignedChoiceAttributeValue!]! +} + +""" +Represents a swatch attribute. + +Added in Saleor 3.22. +""" +type AssignedSwatchAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """The assigned swatch value.""" + value: AssignedSwatchAttributeValue +} + +""" +Represents a single swatch value. + +Added in Saleor 3.22. +""" +type AssignedSwatchAttributeValue @doc(category: "Attributes") { + """Name of the selected swatch value.""" + name: String + + """Slug of the selected swatch value.""" + slug: String + + """Hex color code.""" + hexColor: String + + """File associated with the attribute.""" + file: File +} + +""" +Represents a boolean attribute. + +Added in Saleor 3.22. +""" +type AssignedBooleanAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """The assigned boolean value.""" + value: Boolean +} + +""" +Represents a date attribute. + +Added in Saleor 3.22. +""" +type AssignedDateAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """The assigned date value.""" + value: Date +} + +""" +Represents a date time attribute. + +Added in Saleor 3.22. +""" +type AssignedDateTimeAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """The assigned date time value.""" + value: DateTime +} + +""" +Represents single page reference attribute. + +Added in Saleor 3.22. +""" +type AssignedSinglePageReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """The assigned page reference.""" + value: Page +} + +""" +Represents single product reference attribute. + +Added in Saleor 3.22. +""" +type AssignedSingleProductReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """The assigned product reference.""" + value: Product +} + +""" +Represents single product variant reference attribute. + +Added in Saleor 3.22. +""" +type AssignedSingleProductVariantReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """The assigned product variant reference.""" + value: ProductVariant +} + +""" +Represents single category reference attribute. + +Added in Saleor 3.22. +""" +type AssignedSingleCategoryReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """The assigned category reference.""" + value: Category +} + +""" +Represents single collection reference attribute. + +Added in Saleor 3.22. +""" +type AssignedSingleCollectionReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """The assigned collection reference.""" + value: Collection +} + +""" +Represents multi page reference attribute. + +Added in Saleor 3.22. +""" +type AssignedMultiPageReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """List of assigned page references.""" + value( + """Maximum number of referenced pages to return. Default is 100.""" + limit: PositiveInt = 100 + ): [Page!]! +} + +""" +Represents multi product reference attribute. + +Added in Saleor 3.22. +""" +type AssignedMultiProductReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """List of assigned product references.""" + value( + """Maximum number of referenced products to return. Default is 100.""" + limit: PositiveInt = 100 + ): [Product!]! +} + +""" +Represents multi product variant reference attribute. + +Added in Saleor 3.22. +""" +type AssignedMultiProductVariantReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """List of assigned product variant references.""" + value( + """ + Maximum number of referenced product variants to return. Default is 100. + """ + limit: PositiveInt = 100 + ): [ProductVariant!]! +} + +""" +Represents multi category reference attribute. + +Added in Saleor 3.22. +""" +type AssignedMultiCategoryReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """List of assigned category references.""" + value( + """Maximum number of referenced categories to return. Default is 100.""" + limit: PositiveInt = 100 + ): [Category!]! +} + +""" +Represents multi collection reference attribute. + +Added in Saleor 3.22. +""" +type AssignedMultiCollectionReferenceAttribute implements AssignedAttribute @doc(category: "Attributes") { + """Attribute assigned to an object.""" + attribute: Attribute! + + """List of assigned collection references.""" + value( + """Maximum number of referenced collections to return. Default is 100""" + limit: PositiveInt = 100 + ): [Collection!]! +} + """_Any value scalar as defined by Federation spec.""" scalar _Any """_Entity union as defined by Federation spec.""" -union _Entity = App | Address | User | Group | ProductVariant | Product | ProductType | ProductMedia | Category | Collection | Order | PageType +union _Entity = App | PageType | Address | User | Group | ProductVariant | Product | ProductType | ProductMedia | Category | Collection | Order """_Service manifest as defined by Federation spec.""" type _Service { diff --git a/apps/avatax/graphql/subscriptions/CalculateTaxes.graphql b/apps/avatax/graphql/subscriptions/CalculateTaxes.graphql index a238abdd37..682469366f 100644 --- a/apps/avatax/graphql/subscriptions/CalculateTaxes.graphql +++ b/apps/avatax/graphql/subscriptions/CalculateTaxes.graphql @@ -1,5 +1,13 @@ subscription CalculateTaxes { - event { - ...CalculateTaxesEvent + calculateTaxes(deferIf: ADDRESS_MISSING) { + taxBase { + ...TaxBase + } + recipient { + privateMetadata { + key + value + } + } } } diff --git a/apps/avatax/src/app/api/webhooks/checkout-calculate-taxes/route.ts b/apps/avatax/src/app/api/webhooks/checkout-calculate-taxes/route.ts index d164489c57..48ffe09b01 100644 --- a/apps/avatax/src/app/api/webhooks/checkout-calculate-taxes/route.ts +++ b/apps/avatax/src/app/api/webhooks/checkout-calculate-taxes/route.ts @@ -39,6 +39,7 @@ const handler = checkoutCalculateTaxesSyncWebhook.createHandler(async (_req, ctx kind: SpanKind.SERVER, }, async (span) => { + const payload = ctx.payload.data.calculateTaxes; /** * Create deps in handler, so it's potentially faster and reduce lambda start * TODO: It's rather not true, we should move it outside @@ -47,6 +48,7 @@ const handler = checkoutCalculateTaxesSyncWebhook.createHandler(async (_req, ctx logger, captureException, ); + const useCase = new CalculateTaxesUseCase({ configExtractor: new AppConfigExtractor(), logWriterFactory: new LogWriterFactory(), @@ -57,12 +59,12 @@ const handler = checkoutCalculateTaxesSyncWebhook.createHandler(async (_req, ctx }); try { - const { payload, authData } = ctx; + const { authData } = ctx; subscriptionErrorChecker.checkPayload(payload); - loggerContext.set(ObservabilityAttributes.CHANNEL_SLUG, ctx.payload.taxBase.channel.slug); - loggerContext.set(ObservabilityAttributes.CHECKOUT_ID, ctx.payload.taxBase.sourceObject.id); + loggerContext.set(ObservabilityAttributes.CHANNEL_SLUG, payload.taxBase.channel.slug); + loggerContext.set(ObservabilityAttributes.CHECKOUT_ID, payload.taxBase.sourceObject.id); if (payload.version) { setTag(ObservabilityAttributes.SALEOR_VERSION, payload.version); diff --git a/apps/avatax/src/app/api/webhooks/order-calculate-taxes/route.ts b/apps/avatax/src/app/api/webhooks/order-calculate-taxes/route.ts index 16c5b6f051..03f86d74df 100644 --- a/apps/avatax/src/app/api/webhooks/order-calculate-taxes/route.ts +++ b/apps/avatax/src/app/api/webhooks/order-calculate-taxes/route.ts @@ -113,14 +113,15 @@ const handler = orderCalculateTaxesSyncWebhook.createHandler(async (_req, ctx) = kind: SpanKind.SERVER, }, async (span) => { + const payload = ctx.payload.data.calculateTaxes; + const logWriter = logsWriterFactory.createWriter(ctx.authData); - const channelSlug = ctx.payload.taxBase.channel.slug; - const orderId = ctx.payload.taxBase.sourceObject.id; - const appMetadata = ctx.payload.recipient?.privateMetadata ?? []; + const channelSlug = payload.taxBase.channel.slug; + const orderId = payload.taxBase.sourceObject.id; + const appMetadata = payload.recipient?.privateMetadata ?? []; metadataCache.setMetadata(appMetadata); - const { payload } = ctx; try { subscriptionErrorChecker.checkPayload(payload); diff --git a/apps/avatax/src/modules/webhooks/definitions/checkout-calculate-taxes.ts b/apps/avatax/src/modules/webhooks/definitions/checkout-calculate-taxes.ts index 189d8d02e1..46bf9e78a8 100644 --- a/apps/avatax/src/modules/webhooks/definitions/checkout-calculate-taxes.ts +++ b/apps/avatax/src/modules/webhooks/definitions/checkout-calculate-taxes.ts @@ -4,7 +4,9 @@ import { UntypedCalculateTaxesDocument } from "../../../../generated/graphql"; import { saleorApp } from "../../../../saleor-app"; import { CalculateTaxesPayload } from "../payloads/calculate-taxes-payload"; -export const checkoutCalculateTaxesSyncWebhook = new SaleorSyncWebhook({ +export const checkoutCalculateTaxesSyncWebhook = new SaleorSyncWebhook<{ + data: { calculateTaxes: CalculateTaxesPayload }; +}>({ name: "CheckoutCalculateTaxes", apl: saleorApp.apl, event: "CHECKOUT_CALCULATE_TAXES", diff --git a/apps/avatax/src/modules/webhooks/definitions/order-calculate-taxes.ts b/apps/avatax/src/modules/webhooks/definitions/order-calculate-taxes.ts index a81cac9dfa..3a9bdbd5fe 100644 --- a/apps/avatax/src/modules/webhooks/definitions/order-calculate-taxes.ts +++ b/apps/avatax/src/modules/webhooks/definitions/order-calculate-taxes.ts @@ -4,7 +4,9 @@ import { UntypedCalculateTaxesDocument } from "../../../../generated/graphql"; import { saleorApp } from "../../../../saleor-app"; import { CalculateTaxesPayload } from "../payloads/calculate-taxes-payload"; -export const orderCalculateTaxesSyncWebhook = new SaleorSyncWebhook({ +export const orderCalculateTaxesSyncWebhook = new SaleorSyncWebhook<{ + data: { calculateTaxes: CalculateTaxesPayload }; +}>({ name: "OrderCalculateTaxes", apl: saleorApp.apl, event: "ORDER_CALCULATE_TAXES",