// tslint:disable export type Maybe = T; export type Exact = { [K in keyof T]: T[K] }; export type MakeOptional = Omit & { [SubKey in K]?: Maybe }; export type MakeMaybe = Omit & { [SubKey in K]: Maybe }; /** All built-in and custom scalars, mapped to their actual values */ export type Scalars = { ID: string | number; String: string; Boolean: boolean; Int: number; Float: number; /** A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. */ DateTime: any; /** The `JSON` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf). */ JSON: any; /** The `Upload` scalar type represents a file upload. */ Upload: any; }; export type AddFulfillmentToOrderResult = Fulfillment | EmptyOrderLineSelectionError | ItemsAlreadyFulfilledError | InsufficientStockOnHandError | InvalidFulfillmentHandlerError | FulfillmentStateTransitionError | CreateFulfillmentError; export type AddItemInput = { productVariantId: Scalars['ID']; quantity: Scalars['Int']; }; export type AddManualPaymentToOrderResult = Order | ManualPaymentStateError; export type AddNoteToCustomerInput = { id: Scalars['ID']; note: Scalars['String']; isPublic: Scalars['Boolean']; }; export type AddNoteToOrderInput = { id: Scalars['ID']; note: Scalars['String']; isPublic: Scalars['Boolean']; }; export type Address = Node & { __typename?: 'Address'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; fullName?: Maybe; company?: Maybe; streetLine1: Scalars['String']; streetLine2?: Maybe; city?: Maybe; province?: Maybe; postalCode?: Maybe; country: Country; phoneNumber?: Maybe; defaultShippingAddress?: Maybe; defaultBillingAddress?: Maybe; customFields?: Maybe; }; export type AdjustOrderLineInput = { orderLineId: Scalars['ID']; quantity: Scalars['Int']; }; export type Adjustment = { __typename?: 'Adjustment'; adjustmentSource: Scalars['String']; type: AdjustmentType; description: Scalars['String']; amount: Scalars['Int']; }; export enum AdjustmentType { PROMOTION = 'PROMOTION', DISTRIBUTED_ORDER_PROMOTION = 'DISTRIBUTED_ORDER_PROMOTION' } export type Administrator = Node & { __typename?: 'Administrator'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; firstName: Scalars['String']; lastName: Scalars['String']; emailAddress: Scalars['String']; user: User; customFields?: Maybe; }; export type AdministratorFilterParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; firstName?: Maybe; lastName?: Maybe; emailAddress?: Maybe; }; export type AdministratorList = PaginatedList & { __typename?: 'AdministratorList'; items: Array; totalItems: Scalars['Int']; }; export type AdministratorListOptions = { /** Skips the first n results, for use in pagination */ skip?: Maybe; /** Takes n results, for use in pagination */ take?: Maybe; /** Specifies which properties to sort the results by */ sort?: Maybe; /** Allows the results to be filtered */ filter?: Maybe; /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */ filterOperator?: Maybe; }; export type AdministratorPaymentInput = { paymentMethod?: Maybe; metadata?: Maybe; }; export type AdministratorRefundInput = { paymentId: Scalars['ID']; reason?: Maybe; }; export type AdministratorSortParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; firstName?: Maybe; lastName?: Maybe; emailAddress?: Maybe; }; export type Allocation = Node & StockMovement & { __typename?: 'Allocation'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; productVariant: ProductVariant; type: StockMovementType; quantity: Scalars['Int']; orderLine: OrderLine; }; /** Returned if an attempting to refund an OrderItem which has already been refunded */ export type AlreadyRefundedError = ErrorResult & { __typename?: 'AlreadyRefundedError'; errorCode: ErrorCode; message: Scalars['String']; refundId: Scalars['ID']; }; export type Asset = Node & { __typename?: 'Asset'; tags: Array; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; name: Scalars['String']; type: AssetType; fileSize: Scalars['Int']; mimeType: Scalars['String']; width: Scalars['Int']; height: Scalars['Int']; source: Scalars['String']; preview: Scalars['String']; focalPoint?: Maybe; customFields?: Maybe; }; export type AssetFilterParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; name?: Maybe; type?: Maybe; fileSize?: Maybe; mimeType?: Maybe; width?: Maybe; height?: Maybe; source?: Maybe; preview?: Maybe; }; export type AssetList = PaginatedList & { __typename?: 'AssetList'; items: Array; totalItems: Scalars['Int']; }; export type AssetListOptions = { tags?: Maybe>; tagsOperator?: Maybe; /** Skips the first n results, for use in pagination */ skip?: Maybe; /** Takes n results, for use in pagination */ take?: Maybe; /** Specifies which properties to sort the results by */ sort?: Maybe; /** Allows the results to be filtered */ filter?: Maybe; /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */ filterOperator?: Maybe; }; export type AssetSortParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; name?: Maybe; fileSize?: Maybe; mimeType?: Maybe; width?: Maybe; height?: Maybe; source?: Maybe; preview?: Maybe; }; export enum AssetType { IMAGE = 'IMAGE', VIDEO = 'VIDEO', BINARY = 'BINARY' } export type AssignAssetsToChannelInput = { assetIds: Array; channelId: Scalars['ID']; }; export type AssignProductVariantsToChannelInput = { productVariantIds: Array; channelId: Scalars['ID']; priceFactor?: Maybe; }; export type AssignProductsToChannelInput = { productIds: Array; channelId: Scalars['ID']; priceFactor?: Maybe; }; export type AssignPromotionsToChannelInput = { promotionIds: Array; channelId: Scalars['ID']; }; export type AuthenticationInput = { native?: Maybe; }; export type AuthenticationMethod = Node & { __typename?: 'AuthenticationMethod'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; strategy: Scalars['String']; }; export type AuthenticationResult = CurrentUser | InvalidCredentialsError; export type BooleanCustomFieldConfig = CustomField & { __typename?: 'BooleanCustomFieldConfig'; name: Scalars['String']; type: Scalars['String']; list: Scalars['Boolean']; label?: Maybe>; description?: Maybe>; readonly?: Maybe; internal?: Maybe; nullable?: Maybe; ui?: Maybe; }; /** Operators for filtering on a Boolean field */ export type BooleanOperators = { eq?: Maybe; }; /** Returned if an attempting to cancel lines from an Order which is still active */ export type CancelActiveOrderError = ErrorResult & { __typename?: 'CancelActiveOrderError'; errorCode: ErrorCode; message: Scalars['String']; orderState: Scalars['String']; }; export type CancelOrderInput = { /** The id of the order to be cancelled */ orderId: Scalars['ID']; /** Optionally specify which OrderLines to cancel. If not provided, all OrderLines will be cancelled */ lines?: Maybe>; reason?: Maybe; }; export type CancelOrderResult = Order | EmptyOrderLineSelectionError | QuantityTooGreatError | MultipleOrderError | CancelActiveOrderError | OrderStateTransitionError; export type Cancellation = Node & StockMovement & { __typename?: 'Cancellation'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; productVariant: ProductVariant; type: StockMovementType; quantity: Scalars['Int']; orderLine: OrderLine; }; export type Channel = Node & { __typename?: 'Channel'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; code: Scalars['String']; token: Scalars['String']; defaultTaxZone?: Maybe; defaultShippingZone?: Maybe; defaultLanguageCode: LanguageCode; currencyCode: CurrencyCode; pricesIncludeTax: Scalars['Boolean']; customFields?: Maybe; }; /** * Returned when the default LanguageCode of a Channel is no longer found in the `availableLanguages` * of the GlobalSettings */ export type ChannelDefaultLanguageError = ErrorResult & { __typename?: 'ChannelDefaultLanguageError'; errorCode: ErrorCode; message: Scalars['String']; language: Scalars['String']; channelCode: Scalars['String']; }; export type Collection = Node & { __typename?: 'Collection'; isPrivate: Scalars['Boolean']; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; languageCode?: Maybe; name: Scalars['String']; slug: Scalars['String']; breadcrumbs: Array; position: Scalars['Int']; description: Scalars['String']; featuredAsset?: Maybe; assets: Array; parent?: Maybe; children?: Maybe>; filters: Array; translations: Array; productVariants: ProductVariantList; customFields?: Maybe; }; export type CollectionProductVariantsArgs = { options?: Maybe; }; export type CollectionBreadcrumb = { __typename?: 'CollectionBreadcrumb'; id: Scalars['ID']; name: Scalars['String']; slug: Scalars['String']; }; export type CollectionFilterParameter = { isPrivate?: Maybe; id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; languageCode?: Maybe; name?: Maybe; slug?: Maybe; position?: Maybe; description?: Maybe; }; export type CollectionList = PaginatedList & { __typename?: 'CollectionList'; items: Array; totalItems: Scalars['Int']; }; export type CollectionListOptions = { /** Skips the first n results, for use in pagination */ skip?: Maybe; /** Takes n results, for use in pagination */ take?: Maybe; /** Specifies which properties to sort the results by */ sort?: Maybe; /** Allows the results to be filtered */ filter?: Maybe; /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */ filterOperator?: Maybe; }; /** * Which Collections are present in the products returned * by the search, and in what quantity. */ export type CollectionResult = { __typename?: 'CollectionResult'; collection: Collection; count: Scalars['Int']; }; export type CollectionSortParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; name?: Maybe; slug?: Maybe; position?: Maybe; description?: Maybe; }; export type CollectionTranslation = { __typename?: 'CollectionTranslation'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; languageCode: LanguageCode; name: Scalars['String']; slug: Scalars['String']; description: Scalars['String']; }; export type ConfigArg = { __typename?: 'ConfigArg'; name: Scalars['String']; value: Scalars['String']; }; export type ConfigArgDefinition = { __typename?: 'ConfigArgDefinition'; name: Scalars['String']; type: Scalars['String']; list: Scalars['Boolean']; required: Scalars['Boolean']; defaultValue?: Maybe; label?: Maybe; description?: Maybe; ui?: Maybe; }; export type ConfigArgInput = { name: Scalars['String']; /** A JSON stringified representation of the actual value */ value: Scalars['String']; }; export type ConfigurableOperation = { __typename?: 'ConfigurableOperation'; code: Scalars['String']; args: Array; }; export type ConfigurableOperationDefinition = { __typename?: 'ConfigurableOperationDefinition'; code: Scalars['String']; args: Array; description: Scalars['String']; }; export type ConfigurableOperationInput = { code: Scalars['String']; arguments: Array; }; export type Coordinate = { __typename?: 'Coordinate'; x: Scalars['Float']; y: Scalars['Float']; }; export type CoordinateInput = { x: Scalars['Float']; y: Scalars['Float']; }; export type Country = Node & { __typename?: 'Country'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; languageCode: LanguageCode; code: Scalars['String']; name: Scalars['String']; enabled: Scalars['Boolean']; translations: Array; customFields?: Maybe; }; export type CountryFilterParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; languageCode?: Maybe; code?: Maybe; name?: Maybe; enabled?: Maybe; }; export type CountryList = PaginatedList & { __typename?: 'CountryList'; items: Array; totalItems: Scalars['Int']; }; export type CountryListOptions = { /** Skips the first n results, for use in pagination */ skip?: Maybe; /** Takes n results, for use in pagination */ take?: Maybe; /** Specifies which properties to sort the results by */ sort?: Maybe; /** Allows the results to be filtered */ filter?: Maybe; /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */ filterOperator?: Maybe; }; export type CountrySortParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; code?: Maybe; name?: Maybe; }; export type CountryTranslation = { __typename?: 'CountryTranslation'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; languageCode: LanguageCode; name: Scalars['String']; }; export type CountryTranslationInput = { id?: Maybe; languageCode: LanguageCode; name?: Maybe; customFields?: Maybe; }; export type CreateAddressInput = { fullName?: Maybe; company?: Maybe; streetLine1: Scalars['String']; streetLine2?: Maybe; city?: Maybe; province?: Maybe; postalCode?: Maybe; countryCode: Scalars['String']; phoneNumber?: Maybe; defaultShippingAddress?: Maybe; defaultBillingAddress?: Maybe; customFields?: Maybe; }; export type CreateAdministratorInput = { firstName: Scalars['String']; lastName: Scalars['String']; emailAddress: Scalars['String']; password: Scalars['String']; roleIds: Array; customFields?: Maybe; }; export type CreateAssetInput = { file: Scalars['Upload']; tags?: Maybe>; customFields?: Maybe; }; export type CreateAssetResult = Asset | MimeTypeError; export type CreateChannelInput = { code: Scalars['String']; token: Scalars['String']; defaultLanguageCode: LanguageCode; pricesIncludeTax: Scalars['Boolean']; currencyCode: CurrencyCode; defaultTaxZoneId: Scalars['ID']; defaultShippingZoneId: Scalars['ID']; customFields?: Maybe; }; export type CreateChannelResult = Channel | LanguageNotAvailableError; export type CreateCollectionInput = { isPrivate?: Maybe; featuredAssetId?: Maybe; assetIds?: Maybe>; parentId?: Maybe; filters: Array; translations: Array; customFields?: Maybe; }; export type CreateCollectionTranslationInput = { languageCode: LanguageCode; name: Scalars['String']; slug: Scalars['String']; description: Scalars['String']; customFields?: Maybe; }; export type CreateCountryInput = { code: Scalars['String']; translations: Array; enabled: Scalars['Boolean']; customFields?: Maybe; }; export type CreateCustomerGroupInput = { name: Scalars['String']; customerIds?: Maybe>; customFields?: Maybe; }; export type CreateCustomerInput = { title?: Maybe; firstName: Scalars['String']; lastName: Scalars['String']; phoneNumber?: Maybe; emailAddress: Scalars['String']; customFields?: Maybe; }; export type CreateCustomerResult = Customer | EmailAddressConflictError; export type CreateFacetInput = { code: Scalars['String']; isPrivate: Scalars['Boolean']; translations: Array; values?: Maybe>; customFields?: Maybe; }; export type CreateFacetValueInput = { facetId: Scalars['ID']; code: Scalars['String']; translations: Array; customFields?: Maybe; }; export type CreateFacetValueWithFacetInput = { code: Scalars['String']; translations: Array; }; /** Returned if an error is thrown in a FulfillmentHandler's createFulfillment method */ export type CreateFulfillmentError = ErrorResult & { __typename?: 'CreateFulfillmentError'; errorCode: ErrorCode; message: Scalars['String']; fulfillmentHandlerError: Scalars['String']; }; export type CreateGroupOptionInput = { code: Scalars['String']; translations: Array; }; export type CreatePaymentMethodInput = { name: Scalars['String']; code: Scalars['String']; description?: Maybe; enabled: Scalars['Boolean']; checker?: Maybe; handler: ConfigurableOperationInput; customFields?: Maybe; }; export type CreateProductInput = { featuredAssetId?: Maybe; enabled?: Maybe; assetIds?: Maybe>; facetValueIds?: Maybe>; translations: Array; customFields?: Maybe; }; export type CreateProductOptionGroupInput = { code: Scalars['String']; translations: Array; options: Array; customFields?: Maybe; }; export type CreateProductOptionInput = { productOptionGroupId: Scalars['ID']; code: Scalars['String']; translations: Array; customFields?: Maybe; }; export type CreateProductVariantInput = { productId: Scalars['ID']; translations: Array; facetValueIds?: Maybe>; sku: Scalars['String']; price?: Maybe; taxCategoryId?: Maybe; optionIds?: Maybe>; featuredAssetId?: Maybe; assetIds?: Maybe>; stockOnHand?: Maybe; outOfStockThreshold?: Maybe; useGlobalOutOfStockThreshold?: Maybe; trackInventory?: Maybe; customFields?: Maybe; }; export type CreateProductVariantOptionInput = { optionGroupId: Scalars['ID']; code: Scalars['String']; translations: Array; }; export type CreatePromotionInput = { name: Scalars['String']; enabled: Scalars['Boolean']; startsAt?: Maybe; endsAt?: Maybe; couponCode?: Maybe; perCustomerUsageLimit?: Maybe; conditions: Array; actions: Array; customFields?: Maybe; }; export type CreatePromotionResult = Promotion | MissingConditionsError; export type CreateRoleInput = { code: Scalars['String']; description: Scalars['String']; permissions: Array; channelIds?: Maybe>; }; export type CreateShippingMethodInput = { code: Scalars['String']; fulfillmentHandler: Scalars['String']; checker: ConfigurableOperationInput; calculator: ConfigurableOperationInput; translations: Array; customFields?: Maybe; }; export type CreateTagInput = { value: Scalars['String']; }; export type CreateTaxCategoryInput = { name: Scalars['String']; isDefault?: Maybe; customFields?: Maybe; }; export type CreateTaxRateInput = { name: Scalars['String']; enabled: Scalars['Boolean']; value: Scalars['Float']; categoryId: Scalars['ID']; zoneId: Scalars['ID']; customerGroupId?: Maybe; customFields?: Maybe; }; export type CreateZoneInput = { name: Scalars['String']; memberIds?: Maybe>; customFields?: Maybe; }; /** * @description * ISO 4217 currency code * * @docsCategory common */ export enum CurrencyCode { /** United Arab Emirates dirham */ AED = 'AED', /** Afghan afghani */ AFN = 'AFN', /** Albanian lek */ ALL = 'ALL', /** Armenian dram */ AMD = 'AMD', /** Netherlands Antillean guilder */ ANG = 'ANG', /** Angolan kwanza */ AOA = 'AOA', /** Argentine peso */ ARS = 'ARS', /** Australian dollar */ AUD = 'AUD', /** Aruban florin */ AWG = 'AWG', /** Azerbaijani manat */ AZN = 'AZN', /** Bosnia and Herzegovina convertible mark */ BAM = 'BAM', /** Barbados dollar */ BBD = 'BBD', /** Bangladeshi taka */ BDT = 'BDT', /** Bulgarian lev */ BGN = 'BGN', /** Bahraini dinar */ BHD = 'BHD', /** Burundian franc */ BIF = 'BIF', /** Bermudian dollar */ BMD = 'BMD', /** Brunei dollar */ BND = 'BND', /** Boliviano */ BOB = 'BOB', /** Brazilian real */ BRL = 'BRL', /** Bahamian dollar */ BSD = 'BSD', /** Bhutanese ngultrum */ BTN = 'BTN', /** Botswana pula */ BWP = 'BWP', /** Belarusian ruble */ BYN = 'BYN', /** Belize dollar */ BZD = 'BZD', /** Canadian dollar */ CAD = 'CAD', /** Congolese franc */ CDF = 'CDF', /** Swiss franc */ CHF = 'CHF', /** Chilean peso */ CLP = 'CLP', /** Renminbi (Chinese) yuan */ CNY = 'CNY', /** Colombian peso */ COP = 'COP', /** Costa Rican colon */ CRC = 'CRC', /** Cuban convertible peso */ CUC = 'CUC', /** Cuban peso */ CUP = 'CUP', /** Cape Verde escudo */ CVE = 'CVE', /** Czech koruna */ CZK = 'CZK', /** Djiboutian franc */ DJF = 'DJF', /** Danish krone */ DKK = 'DKK', /** Dominican peso */ DOP = 'DOP', /** Algerian dinar */ DZD = 'DZD', /** Egyptian pound */ EGP = 'EGP', /** Eritrean nakfa */ ERN = 'ERN', /** Ethiopian birr */ ETB = 'ETB', /** Euro */ EUR = 'EUR', /** Fiji dollar */ FJD = 'FJD', /** Falkland Islands pound */ FKP = 'FKP', /** Pound sterling */ GBP = 'GBP', /** Georgian lari */ GEL = 'GEL', /** Ghanaian cedi */ GHS = 'GHS', /** Gibraltar pound */ GIP = 'GIP', /** Gambian dalasi */ GMD = 'GMD', /** Guinean franc */ GNF = 'GNF', /** Guatemalan quetzal */ GTQ = 'GTQ', /** Guyanese dollar */ GYD = 'GYD', /** Hong Kong dollar */ HKD = 'HKD', /** Honduran lempira */ HNL = 'HNL', /** Croatian kuna */ HRK = 'HRK', /** Haitian gourde */ HTG = 'HTG', /** Hungarian forint */ HUF = 'HUF', /** Indonesian rupiah */ IDR = 'IDR', /** Israeli new shekel */ ILS = 'ILS', /** Indian rupee */ INR = 'INR', /** Iraqi dinar */ IQD = 'IQD', /** Iranian rial */ IRR = 'IRR', /** Icelandic króna */ ISK = 'ISK', /** Jamaican dollar */ JMD = 'JMD', /** Jordanian dinar */ JOD = 'JOD', /** Japanese yen */ JPY = 'JPY', /** Kenyan shilling */ KES = 'KES', /** Kyrgyzstani som */ KGS = 'KGS', /** Cambodian riel */ KHR = 'KHR', /** Comoro franc */ KMF = 'KMF', /** North Korean won */ KPW = 'KPW', /** South Korean won */ KRW = 'KRW', /** Kuwaiti dinar */ KWD = 'KWD', /** Cayman Islands dollar */ KYD = 'KYD', /** Kazakhstani tenge */ KZT = 'KZT', /** Lao kip */ LAK = 'LAK', /** Lebanese pound */ LBP = 'LBP', /** Sri Lankan rupee */ LKR = 'LKR', /** Liberian dollar */ LRD = 'LRD', /** Lesotho loti */ LSL = 'LSL', /** Libyan dinar */ LYD = 'LYD', /** Moroccan dirham */ MAD = 'MAD', /** Moldovan leu */ MDL = 'MDL', /** Malagasy ariary */ MGA = 'MGA', /** Macedonian denar */ MKD = 'MKD', /** Myanmar kyat */ MMK = 'MMK', /** Mongolian tögrög */ MNT = 'MNT', /** Macanese pataca */ MOP = 'MOP', /** Mauritanian ouguiya */ MRU = 'MRU', /** Mauritian rupee */ MUR = 'MUR', /** Maldivian rufiyaa */ MVR = 'MVR', /** Malawian kwacha */ MWK = 'MWK', /** Mexican peso */ MXN = 'MXN', /** Malaysian ringgit */ MYR = 'MYR', /** Mozambican metical */ MZN = 'MZN', /** Namibian dollar */ NAD = 'NAD', /** Nigerian naira */ NGN = 'NGN', /** Nicaraguan córdoba */ NIO = 'NIO', /** Norwegian krone */ NOK = 'NOK', /** Nepalese rupee */ NPR = 'NPR', /** New Zealand dollar */ NZD = 'NZD', /** Omani rial */ OMR = 'OMR', /** Panamanian balboa */ PAB = 'PAB', /** Peruvian sol */ PEN = 'PEN', /** Papua New Guinean kina */ PGK = 'PGK', /** Philippine peso */ PHP = 'PHP', /** Pakistani rupee */ PKR = 'PKR', /** Polish złoty */ PLN = 'PLN', /** Paraguayan guaraní */ PYG = 'PYG', /** Qatari riyal */ QAR = 'QAR', /** Romanian leu */ RON = 'RON', /** Serbian dinar */ RSD = 'RSD', /** Russian ruble */ RUB = 'RUB', /** Rwandan franc */ RWF = 'RWF', /** Saudi riyal */ SAR = 'SAR', /** Solomon Islands dollar */ SBD = 'SBD', /** Seychelles rupee */ SCR = 'SCR', /** Sudanese pound */ SDG = 'SDG', /** Swedish krona/kronor */ SEK = 'SEK', /** Singapore dollar */ SGD = 'SGD', /** Saint Helena pound */ SHP = 'SHP', /** Sierra Leonean leone */ SLL = 'SLL', /** Somali shilling */ SOS = 'SOS', /** Surinamese dollar */ SRD = 'SRD', /** South Sudanese pound */ SSP = 'SSP', /** São Tomé and Príncipe dobra */ STN = 'STN', /** Salvadoran colón */ SVC = 'SVC', /** Syrian pound */ SYP = 'SYP', /** Swazi lilangeni */ SZL = 'SZL', /** Thai baht */ THB = 'THB', /** Tajikistani somoni */ TJS = 'TJS', /** Turkmenistan manat */ TMT = 'TMT', /** Tunisian dinar */ TND = 'TND', /** Tongan paʻanga */ TOP = 'TOP', /** Turkish lira */ TRY = 'TRY', /** Trinidad and Tobago dollar */ TTD = 'TTD', /** New Taiwan dollar */ TWD = 'TWD', /** Tanzanian shilling */ TZS = 'TZS', /** Ukrainian hryvnia */ UAH = 'UAH', /** Ugandan shilling */ UGX = 'UGX', /** United States dollar */ USD = 'USD', /** Uruguayan peso */ UYU = 'UYU', /** Uzbekistan som */ UZS = 'UZS', /** Venezuelan bolívar soberano */ VES = 'VES', /** Vietnamese đồng */ VND = 'VND', /** Vanuatu vatu */ VUV = 'VUV', /** Samoan tala */ WST = 'WST', /** CFA franc BEAC */ XAF = 'XAF', /** East Caribbean dollar */ XCD = 'XCD', /** CFA franc BCEAO */ XOF = 'XOF', /** CFP franc (franc Pacifique) */ XPF = 'XPF', /** Yemeni rial */ YER = 'YER', /** South African rand */ ZAR = 'ZAR', /** Zambian kwacha */ ZMW = 'ZMW', /** Zimbabwean dollar */ ZWL = 'ZWL' } export type CurrentUser = { __typename?: 'CurrentUser'; id: Scalars['ID']; identifier: Scalars['String']; channels: Array; }; export type CurrentUserChannel = { __typename?: 'CurrentUserChannel'; id: Scalars['ID']; token: Scalars['String']; code: Scalars['String']; permissions: Array; }; export type CustomField = { name: Scalars['String']; type: Scalars['String']; list: Scalars['Boolean']; label?: Maybe>; description?: Maybe>; readonly?: Maybe; internal?: Maybe; nullable?: Maybe; ui?: Maybe; }; export type CustomFieldConfig = StringCustomFieldConfig | LocaleStringCustomFieldConfig | IntCustomFieldConfig | FloatCustomFieldConfig | BooleanCustomFieldConfig | DateTimeCustomFieldConfig | RelationCustomFieldConfig | TextCustomFieldConfig; export type CustomFields = { __typename?: 'CustomFields'; Address: Array; Administrator: Array; Asset: Array; Channel: Array; Collection: Array; Country: Array; Customer: Array; CustomerGroup: Array; Facet: Array; FacetValue: Array; Fulfillment: Array; GlobalSettings: Array; Order: Array; OrderLine: Array; PaymentMethod: Array; Product: Array; ProductOption: Array; ProductOptionGroup: Array; ProductVariant: Array; Promotion: Array; ShippingMethod: Array; TaxCategory: Array; TaxRate: Array; User: Array; Zone: Array; }; export type Customer = Node & { __typename?: 'Customer'; groups: Array; history: HistoryEntryList; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; title?: Maybe; firstName: Scalars['String']; lastName: Scalars['String']; phoneNumber?: Maybe; emailAddress: Scalars['String']; addresses?: Maybe>; orders: OrderList; user?: Maybe; customFields?: Maybe; }; export type CustomerHistoryArgs = { options?: Maybe; }; export type CustomerOrdersArgs = { options?: Maybe; }; export type CustomerFilterParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; title?: Maybe; firstName?: Maybe; lastName?: Maybe; phoneNumber?: Maybe; emailAddress?: Maybe; }; export type CustomerGroup = Node & { __typename?: 'CustomerGroup'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; name: Scalars['String']; customers: CustomerList; customFields?: Maybe; }; export type CustomerGroupCustomersArgs = { options?: Maybe; }; export type CustomerGroupFilterParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; name?: Maybe; }; export type CustomerGroupList = PaginatedList & { __typename?: 'CustomerGroupList'; items: Array; totalItems: Scalars['Int']; }; export type CustomerGroupListOptions = { /** Skips the first n results, for use in pagination */ skip?: Maybe; /** Takes n results, for use in pagination */ take?: Maybe; /** Specifies which properties to sort the results by */ sort?: Maybe; /** Allows the results to be filtered */ filter?: Maybe; /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */ filterOperator?: Maybe; }; export type CustomerGroupSortParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; name?: Maybe; }; export type CustomerList = PaginatedList & { __typename?: 'CustomerList'; items: Array; totalItems: Scalars['Int']; }; export type CustomerListOptions = { /** Skips the first n results, for use in pagination */ skip?: Maybe; /** Takes n results, for use in pagination */ take?: Maybe; /** Specifies which properties to sort the results by */ sort?: Maybe; /** Allows the results to be filtered */ filter?: Maybe; /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */ filterOperator?: Maybe; }; export type CustomerSortParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; title?: Maybe; firstName?: Maybe; lastName?: Maybe; phoneNumber?: Maybe; emailAddress?: Maybe; }; /** Operators for filtering on a DateTime field */ export type DateOperators = { eq?: Maybe; before?: Maybe; after?: Maybe; between?: Maybe; }; export type DateRange = { start: Scalars['DateTime']; end: Scalars['DateTime']; }; /** * Expects the same validation formats as the `` HTML element. * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes */ export type DateTimeCustomFieldConfig = CustomField & { __typename?: 'DateTimeCustomFieldConfig'; name: Scalars['String']; type: Scalars['String']; list: Scalars['Boolean']; label?: Maybe>; description?: Maybe>; readonly?: Maybe; internal?: Maybe; nullable?: Maybe; min?: Maybe; max?: Maybe; step?: Maybe; ui?: Maybe; }; export type DeleteAssetInput = { assetId: Scalars['ID']; force?: Maybe; deleteFromAllChannels?: Maybe; }; export type DeleteAssetsInput = { assetIds: Array; force?: Maybe; deleteFromAllChannels?: Maybe; }; export type DeletionResponse = { __typename?: 'DeletionResponse'; result: DeletionResult; message?: Maybe; }; export enum DeletionResult { /** The entity was successfully deleted */ DELETED = 'DELETED', /** Deletion did not take place, reason given in message */ NOT_DELETED = 'NOT_DELETED' } export type Discount = { __typename?: 'Discount'; adjustmentSource: Scalars['String']; type: AdjustmentType; description: Scalars['String']; amount: Scalars['Int']; amountWithTax: Scalars['Int']; }; /** Returned when attempting to create a Customer with an email address already registered to an existing User. */ export type EmailAddressConflictError = ErrorResult & { __typename?: 'EmailAddressConflictError'; errorCode: ErrorCode; message: Scalars['String']; }; /** Returned if no OrderLines have been specified for the operation */ export type EmptyOrderLineSelectionError = ErrorResult & { __typename?: 'EmptyOrderLineSelectionError'; errorCode: ErrorCode; message: Scalars['String']; }; export enum ErrorCode { UNKNOWN_ERROR = 'UNKNOWN_ERROR', MIME_TYPE_ERROR = 'MIME_TYPE_ERROR', LANGUAGE_NOT_AVAILABLE_ERROR = 'LANGUAGE_NOT_AVAILABLE_ERROR', CHANNEL_DEFAULT_LANGUAGE_ERROR = 'CHANNEL_DEFAULT_LANGUAGE_ERROR', SETTLE_PAYMENT_ERROR = 'SETTLE_PAYMENT_ERROR', EMPTY_ORDER_LINE_SELECTION_ERROR = 'EMPTY_ORDER_LINE_SELECTION_ERROR', ITEMS_ALREADY_FULFILLED_ERROR = 'ITEMS_ALREADY_FULFILLED_ERROR', INVALID_FULFILLMENT_HANDLER_ERROR = 'INVALID_FULFILLMENT_HANDLER_ERROR', CREATE_FULFILLMENT_ERROR = 'CREATE_FULFILLMENT_ERROR', INSUFFICIENT_STOCK_ON_HAND_ERROR = 'INSUFFICIENT_STOCK_ON_HAND_ERROR', MULTIPLE_ORDER_ERROR = 'MULTIPLE_ORDER_ERROR', CANCEL_ACTIVE_ORDER_ERROR = 'CANCEL_ACTIVE_ORDER_ERROR', PAYMENT_ORDER_MISMATCH_ERROR = 'PAYMENT_ORDER_MISMATCH_ERROR', REFUND_ORDER_STATE_ERROR = 'REFUND_ORDER_STATE_ERROR', NOTHING_TO_REFUND_ERROR = 'NOTHING_TO_REFUND_ERROR', ALREADY_REFUNDED_ERROR = 'ALREADY_REFUNDED_ERROR', QUANTITY_TOO_GREAT_ERROR = 'QUANTITY_TOO_GREAT_ERROR', REFUND_STATE_TRANSITION_ERROR = 'REFUND_STATE_TRANSITION_ERROR', PAYMENT_STATE_TRANSITION_ERROR = 'PAYMENT_STATE_TRANSITION_ERROR', FULFILLMENT_STATE_TRANSITION_ERROR = 'FULFILLMENT_STATE_TRANSITION_ERROR', ORDER_MODIFICATION_STATE_ERROR = 'ORDER_MODIFICATION_STATE_ERROR', NO_CHANGES_SPECIFIED_ERROR = 'NO_CHANGES_SPECIFIED_ERROR', PAYMENT_METHOD_MISSING_ERROR = 'PAYMENT_METHOD_MISSING_ERROR', REFUND_PAYMENT_ID_MISSING_ERROR = 'REFUND_PAYMENT_ID_MISSING_ERROR', MANUAL_PAYMENT_STATE_ERROR = 'MANUAL_PAYMENT_STATE_ERROR', PRODUCT_OPTION_IN_USE_ERROR = 'PRODUCT_OPTION_IN_USE_ERROR', MISSING_CONDITIONS_ERROR = 'MISSING_CONDITIONS_ERROR', NATIVE_AUTH_STRATEGY_ERROR = 'NATIVE_AUTH_STRATEGY_ERROR', INVALID_CREDENTIALS_ERROR = 'INVALID_CREDENTIALS_ERROR', ORDER_STATE_TRANSITION_ERROR = 'ORDER_STATE_TRANSITION_ERROR', EMAIL_ADDRESS_CONFLICT_ERROR = 'EMAIL_ADDRESS_CONFLICT_ERROR', ORDER_LIMIT_ERROR = 'ORDER_LIMIT_ERROR', NEGATIVE_QUANTITY_ERROR = 'NEGATIVE_QUANTITY_ERROR', INSUFFICIENT_STOCK_ERROR = 'INSUFFICIENT_STOCK_ERROR' } export type ErrorResult = { errorCode: ErrorCode; message: Scalars['String']; }; export type Facet = Node & { __typename?: 'Facet'; isPrivate: Scalars['Boolean']; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; languageCode: LanguageCode; name: Scalars['String']; code: Scalars['String']; values: Array; translations: Array; customFields?: Maybe; }; export type FacetFilterParameter = { isPrivate?: Maybe; id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; languageCode?: Maybe; name?: Maybe; code?: Maybe; }; export type FacetList = PaginatedList & { __typename?: 'FacetList'; items: Array; totalItems: Scalars['Int']; }; export type FacetListOptions = { /** Skips the first n results, for use in pagination */ skip?: Maybe; /** Takes n results, for use in pagination */ take?: Maybe; /** Specifies which properties to sort the results by */ sort?: Maybe; /** Allows the results to be filtered */ filter?: Maybe; /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */ filterOperator?: Maybe; }; export type FacetSortParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; name?: Maybe; code?: Maybe; }; export type FacetTranslation = { __typename?: 'FacetTranslation'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; languageCode: LanguageCode; name: Scalars['String']; }; export type FacetTranslationInput = { id?: Maybe; languageCode: LanguageCode; name?: Maybe; customFields?: Maybe; }; export type FacetValue = Node & { __typename?: 'FacetValue'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; languageCode: LanguageCode; facet: Facet; name: Scalars['String']; code: Scalars['String']; translations: Array; customFields?: Maybe; }; /** * Used to construct boolean expressions for filtering search results * by FacetValue ID. Examples: * * * ID=1 OR ID=2: `{ facetValueFilters: [{ or: [1,2] }] }` * * ID=1 AND ID=2: `{ facetValueFilters: [{ and: 1 }, { and: 2 }] }` * * ID=1 AND (ID=2 OR ID=3): `{ facetValueFilters: [{ and: 1 }, { or: [2,3] }] }` */ export type FacetValueFilterInput = { and?: Maybe; or?: Maybe>; }; /** * Which FacetValues are present in the products returned * by the search, and in what quantity. */ export type FacetValueResult = { __typename?: 'FacetValueResult'; facetValue: FacetValue; count: Scalars['Int']; }; export type FacetValueTranslation = { __typename?: 'FacetValueTranslation'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; languageCode: LanguageCode; name: Scalars['String']; }; export type FacetValueTranslationInput = { id?: Maybe; languageCode: LanguageCode; name?: Maybe; customFields?: Maybe; }; export type FloatCustomFieldConfig = CustomField & { __typename?: 'FloatCustomFieldConfig'; name: Scalars['String']; type: Scalars['String']; list: Scalars['Boolean']; label?: Maybe>; description?: Maybe>; readonly?: Maybe; internal?: Maybe; nullable?: Maybe; min?: Maybe; max?: Maybe; step?: Maybe; ui?: Maybe; }; export type FulfillOrderInput = { lines: Array; handler: ConfigurableOperationInput; }; export type Fulfillment = Node & { __typename?: 'Fulfillment'; nextStates: Array; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; orderItems: Array; state: Scalars['String']; method: Scalars['String']; trackingCode?: Maybe; customFields?: Maybe; }; /** Returned when there is an error in transitioning the Fulfillment state */ export type FulfillmentStateTransitionError = ErrorResult & { __typename?: 'FulfillmentStateTransitionError'; errorCode: ErrorCode; message: Scalars['String']; transitionError: Scalars['String']; fromState: Scalars['String']; toState: Scalars['String']; }; export enum GlobalFlag { TRUE = 'TRUE', FALSE = 'FALSE', INHERIT = 'INHERIT' } export type GlobalSettings = { __typename?: 'GlobalSettings'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; availableLanguages: Array; trackInventory: Scalars['Boolean']; outOfStockThreshold: Scalars['Int']; serverConfig: ServerConfig; customFields?: Maybe; }; export type HistoryEntry = Node & { __typename?: 'HistoryEntry'; isPublic: Scalars['Boolean']; administrator?: Maybe; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; type: HistoryEntryType; data: Scalars['JSON']; }; export type HistoryEntryFilterParameter = { isPublic?: Maybe; id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; type?: Maybe; }; export type HistoryEntryList = PaginatedList & { __typename?: 'HistoryEntryList'; items: Array; totalItems: Scalars['Int']; }; export type HistoryEntryListOptions = { /** Skips the first n results, for use in pagination */ skip?: Maybe; /** Takes n results, for use in pagination */ take?: Maybe; /** Specifies which properties to sort the results by */ sort?: Maybe; /** Allows the results to be filtered */ filter?: Maybe; /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */ filterOperator?: Maybe; }; export type HistoryEntrySortParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; }; export enum HistoryEntryType { CUSTOMER_REGISTERED = 'CUSTOMER_REGISTERED', CUSTOMER_VERIFIED = 'CUSTOMER_VERIFIED', CUSTOMER_DETAIL_UPDATED = 'CUSTOMER_DETAIL_UPDATED', CUSTOMER_ADDED_TO_GROUP = 'CUSTOMER_ADDED_TO_GROUP', CUSTOMER_REMOVED_FROM_GROUP = 'CUSTOMER_REMOVED_FROM_GROUP', CUSTOMER_ADDRESS_CREATED = 'CUSTOMER_ADDRESS_CREATED', CUSTOMER_ADDRESS_UPDATED = 'CUSTOMER_ADDRESS_UPDATED', CUSTOMER_ADDRESS_DELETED = 'CUSTOMER_ADDRESS_DELETED', CUSTOMER_PASSWORD_UPDATED = 'CUSTOMER_PASSWORD_UPDATED', CUSTOMER_PASSWORD_RESET_REQUESTED = 'CUSTOMER_PASSWORD_RESET_REQUESTED', CUSTOMER_PASSWORD_RESET_VERIFIED = 'CUSTOMER_PASSWORD_RESET_VERIFIED', CUSTOMER_EMAIL_UPDATE_REQUESTED = 'CUSTOMER_EMAIL_UPDATE_REQUESTED', CUSTOMER_EMAIL_UPDATE_VERIFIED = 'CUSTOMER_EMAIL_UPDATE_VERIFIED', CUSTOMER_NOTE = 'CUSTOMER_NOTE', ORDER_STATE_TRANSITION = 'ORDER_STATE_TRANSITION', ORDER_PAYMENT_TRANSITION = 'ORDER_PAYMENT_TRANSITION', ORDER_FULFILLMENT = 'ORDER_FULFILLMENT', ORDER_CANCELLATION = 'ORDER_CANCELLATION', ORDER_REFUND_TRANSITION = 'ORDER_REFUND_TRANSITION', ORDER_FULFILLMENT_TRANSITION = 'ORDER_FULFILLMENT_TRANSITION', ORDER_NOTE = 'ORDER_NOTE', ORDER_COUPON_APPLIED = 'ORDER_COUPON_APPLIED', ORDER_COUPON_REMOVED = 'ORDER_COUPON_REMOVED', ORDER_MODIFIED = 'ORDER_MODIFIED' } /** Operators for filtering on an ID field */ export type IdOperators = { eq?: Maybe; notEq?: Maybe; in?: Maybe>; notIn?: Maybe>; }; export type ImportInfo = { __typename?: 'ImportInfo'; errors?: Maybe>; processed: Scalars['Int']; imported: Scalars['Int']; }; /** Returned when attempting to add more items to the Order than are available */ export type InsufficientStockError = ErrorResult & { __typename?: 'InsufficientStockError'; errorCode: ErrorCode; message: Scalars['String']; quantityAvailable: Scalars['Int']; order: Order; }; /** * Returned if attempting to create a Fulfillment when there is insufficient * stockOnHand of a ProductVariant to satisfy the requested quantity. */ export type InsufficientStockOnHandError = ErrorResult & { __typename?: 'InsufficientStockOnHandError'; errorCode: ErrorCode; message: Scalars['String']; productVariantId: Scalars['ID']; productVariantName: Scalars['String']; stockOnHand: Scalars['Int']; }; export type IntCustomFieldConfig = CustomField & { __typename?: 'IntCustomFieldConfig'; name: Scalars['String']; type: Scalars['String']; list: Scalars['Boolean']; label?: Maybe>; description?: Maybe>; readonly?: Maybe; internal?: Maybe; nullable?: Maybe; min?: Maybe; max?: Maybe; step?: Maybe; ui?: Maybe; }; /** Returned if the user authentication credentials are not valid */ export type InvalidCredentialsError = ErrorResult & { __typename?: 'InvalidCredentialsError'; errorCode: ErrorCode; message: Scalars['String']; authenticationError: Scalars['String']; }; /** Returned if the specified FulfillmentHandler code is not valid */ export type InvalidFulfillmentHandlerError = ErrorResult & { __typename?: 'InvalidFulfillmentHandlerError'; errorCode: ErrorCode; message: Scalars['String']; }; /** Returned if the specified items are already part of a Fulfillment */ export type ItemsAlreadyFulfilledError = ErrorResult & { __typename?: 'ItemsAlreadyFulfilledError'; errorCode: ErrorCode; message: Scalars['String']; }; export type Job = Node & { __typename?: 'Job'; id: Scalars['ID']; createdAt: Scalars['DateTime']; startedAt?: Maybe; settledAt?: Maybe; queueName: Scalars['String']; state: JobState; progress: Scalars['Float']; data?: Maybe; result?: Maybe; error?: Maybe; isSettled: Scalars['Boolean']; duration: Scalars['Int']; retries: Scalars['Int']; attempts: Scalars['Int']; }; export type JobBufferSize = { __typename?: 'JobBufferSize'; bufferId: Scalars['String']; size: Scalars['Int']; }; export type JobFilterParameter = { id?: Maybe; createdAt?: Maybe; startedAt?: Maybe; settledAt?: Maybe; queueName?: Maybe; state?: Maybe; progress?: Maybe; isSettled?: Maybe; duration?: Maybe; retries?: Maybe; attempts?: Maybe; }; export type JobList = PaginatedList & { __typename?: 'JobList'; items: Array; totalItems: Scalars['Int']; }; export type JobListOptions = { /** Skips the first n results, for use in pagination */ skip?: Maybe; /** Takes n results, for use in pagination */ take?: Maybe; /** Specifies which properties to sort the results by */ sort?: Maybe; /** Allows the results to be filtered */ filter?: Maybe; /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */ filterOperator?: Maybe; }; export type JobQueue = { __typename?: 'JobQueue'; name: Scalars['String']; running: Scalars['Boolean']; }; export type JobSortParameter = { id?: Maybe; createdAt?: Maybe; startedAt?: Maybe; settledAt?: Maybe; queueName?: Maybe; progress?: Maybe; duration?: Maybe; retries?: Maybe; attempts?: Maybe; }; /** * @description * The state of a Job in the JobQueue * * @docsCategory common */ export enum JobState { PENDING = 'PENDING', RUNNING = 'RUNNING', COMPLETED = 'COMPLETED', RETRYING = 'RETRYING', FAILED = 'FAILED', CANCELLED = 'CANCELLED' } /** * @description * Languages in the form of a ISO 639-1 language code with optional * region or script modifier (e.g. de_AT). The selection available is based * on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html) * and includes the major spoken languages of the world and any widely-used variants. * * @docsCategory common */ export enum LanguageCode { /** Afrikaans */ af = 'af', /** Akan */ ak = 'ak', /** Albanian */ sq = 'sq', /** Amharic */ am = 'am', /** Arabic */ ar = 'ar', /** Armenian */ hy = 'hy', /** Assamese */ as = 'as', /** Azerbaijani */ az = 'az', /** Bambara */ bm = 'bm', /** Bangla */ bn = 'bn', /** Basque */ eu = 'eu', /** Belarusian */ be = 'be', /** Bosnian */ bs = 'bs', /** Breton */ br = 'br', /** Bulgarian */ bg = 'bg', /** Burmese */ my = 'my', /** Catalan */ ca = 'ca', /** Chechen */ ce = 'ce', /** Chinese */ zh = 'zh', /** Simplified Chinese */ zh_Hans = 'zh_Hans', /** Traditional Chinese */ zh_Hant = 'zh_Hant', /** Church Slavic */ cu = 'cu', /** Cornish */ kw = 'kw', /** Corsican */ co = 'co', /** Croatian */ hr = 'hr', /** Czech */ cs = 'cs', /** Danish */ da = 'da', /** Dutch */ nl = 'nl', /** Flemish */ nl_BE = 'nl_BE', /** Dzongkha */ dz = 'dz', /** English */ en = 'en', /** Australian English */ en_AU = 'en_AU', /** Canadian English */ en_CA = 'en_CA', /** British English */ en_GB = 'en_GB', /** American English */ en_US = 'en_US', /** Esperanto */ eo = 'eo', /** Estonian */ et = 'et', /** Ewe */ ee = 'ee', /** Faroese */ fo = 'fo', /** Finnish */ fi = 'fi', /** French */ fr = 'fr', /** Canadian French */ fr_CA = 'fr_CA', /** Swiss French */ fr_CH = 'fr_CH', /** Fulah */ ff = 'ff', /** Galician */ gl = 'gl', /** Ganda */ lg = 'lg', /** Georgian */ ka = 'ka', /** German */ de = 'de', /** Austrian German */ de_AT = 'de_AT', /** Swiss High German */ de_CH = 'de_CH', /** Greek */ el = 'el', /** Gujarati */ gu = 'gu', /** Haitian Creole */ ht = 'ht', /** Hausa */ ha = 'ha', /** Hebrew */ he = 'he', /** Hindi */ hi = 'hi', /** Hungarian */ hu = 'hu', /** Icelandic */ is = 'is', /** Igbo */ ig = 'ig', /** Indonesian */ id = 'id', /** Interlingua */ ia = 'ia', /** Irish */ ga = 'ga', /** Italian */ it = 'it', /** Japanese */ ja = 'ja', /** Javanese */ jv = 'jv', /** Kalaallisut */ kl = 'kl', /** Kannada */ kn = 'kn', /** Kashmiri */ ks = 'ks', /** Kazakh */ kk = 'kk', /** Khmer */ km = 'km', /** Kikuyu */ ki = 'ki', /** Kinyarwanda */ rw = 'rw', /** Korean */ ko = 'ko', /** Kurdish */ ku = 'ku', /** Kyrgyz */ ky = 'ky', /** Lao */ lo = 'lo', /** Latin */ la = 'la', /** Latvian */ lv = 'lv', /** Lingala */ ln = 'ln', /** Lithuanian */ lt = 'lt', /** Luba-Katanga */ lu = 'lu', /** Luxembourgish */ lb = 'lb', /** Macedonian */ mk = 'mk', /** Malagasy */ mg = 'mg', /** Malay */ ms = 'ms', /** Malayalam */ ml = 'ml', /** Maltese */ mt = 'mt', /** Manx */ gv = 'gv', /** Maori */ mi = 'mi', /** Marathi */ mr = 'mr', /** Mongolian */ mn = 'mn', /** Nepali */ ne = 'ne', /** North Ndebele */ nd = 'nd', /** Northern Sami */ se = 'se', /** Norwegian Bokmål */ nb = 'nb', /** Norwegian Nynorsk */ nn = 'nn', /** Nyanja */ ny = 'ny', /** Odia */ or = 'or', /** Oromo */ om = 'om', /** Ossetic */ os = 'os', /** Pashto */ ps = 'ps', /** Persian */ fa = 'fa', /** Dari */ fa_AF = 'fa_AF', /** Polish */ pl = 'pl', /** Portuguese */ pt = 'pt', /** Brazilian Portuguese */ pt_BR = 'pt_BR', /** European Portuguese */ pt_PT = 'pt_PT', /** Punjabi */ pa = 'pa', /** Quechua */ qu = 'qu', /** Romanian */ ro = 'ro', /** Moldavian */ ro_MD = 'ro_MD', /** Romansh */ rm = 'rm', /** Rundi */ rn = 'rn', /** Russian */ ru = 'ru', /** Samoan */ sm = 'sm', /** Sango */ sg = 'sg', /** Sanskrit */ sa = 'sa', /** Scottish Gaelic */ gd = 'gd', /** Serbian */ sr = 'sr', /** Shona */ sn = 'sn', /** Sichuan Yi */ ii = 'ii', /** Sindhi */ sd = 'sd', /** Sinhala */ si = 'si', /** Slovak */ sk = 'sk', /** Slovenian */ sl = 'sl', /** Somali */ so = 'so', /** Southern Sotho */ st = 'st', /** Spanish */ es = 'es', /** European Spanish */ es_ES = 'es_ES', /** Mexican Spanish */ es_MX = 'es_MX', /** Sundanese */ su = 'su', /** Swahili */ sw = 'sw', /** Congo Swahili */ sw_CD = 'sw_CD', /** Swedish */ sv = 'sv', /** Tajik */ tg = 'tg', /** Tamil */ ta = 'ta', /** Tatar */ tt = 'tt', /** Telugu */ te = 'te', /** Thai */ th = 'th', /** Tibetan */ bo = 'bo', /** Tigrinya */ ti = 'ti', /** Tongan */ to = 'to', /** Turkish */ tr = 'tr', /** Turkmen */ tk = 'tk', /** Ukrainian */ uk = 'uk', /** Urdu */ ur = 'ur', /** Uyghur */ ug = 'ug', /** Uzbek */ uz = 'uz', /** Vietnamese */ vi = 'vi', /** Volapük */ vo = 'vo', /** Welsh */ cy = 'cy', /** Western Frisian */ fy = 'fy', /** Wolof */ wo = 'wo', /** Xhosa */ xh = 'xh', /** Yiddish */ yi = 'yi', /** Yoruba */ yo = 'yo', /** Zulu */ zu = 'zu' } /** Returned if attempting to set a Channel's defaultLanguageCode to a language which is not enabled in GlobalSettings */ export type LanguageNotAvailableError = ErrorResult & { __typename?: 'LanguageNotAvailableError'; errorCode: ErrorCode; message: Scalars['String']; languageCode: Scalars['String']; }; export type LocaleStringCustomFieldConfig = CustomField & { __typename?: 'LocaleStringCustomFieldConfig'; name: Scalars['String']; type: Scalars['String']; list: Scalars['Boolean']; length?: Maybe; label?: Maybe>; description?: Maybe>; readonly?: Maybe; internal?: Maybe; nullable?: Maybe; pattern?: Maybe; ui?: Maybe; }; export type LocalizedString = { __typename?: 'LocalizedString'; languageCode: LanguageCode; value: Scalars['String']; }; export enum LogicalOperator { AND = 'AND', OR = 'OR' } export type ManualPaymentInput = { orderId: Scalars['ID']; method: Scalars['String']; transactionId?: Maybe; metadata?: Maybe; }; /** * Returned when a call to addManualPaymentToOrder is made but the Order * is not in the required state. */ export type ManualPaymentStateError = ErrorResult & { __typename?: 'ManualPaymentStateError'; errorCode: ErrorCode; message: Scalars['String']; }; export type MimeTypeError = ErrorResult & { __typename?: 'MimeTypeError'; errorCode: ErrorCode; message: Scalars['String']; fileName: Scalars['String']; mimeType: Scalars['String']; }; /** Returned if a PromotionCondition has neither a couponCode nor any conditions set */ export type MissingConditionsError = ErrorResult & { __typename?: 'MissingConditionsError'; errorCode: ErrorCode; message: Scalars['String']; }; export type ModifyOrderInput = { dryRun: Scalars['Boolean']; orderId: Scalars['ID']; addItems?: Maybe>; adjustOrderLines?: Maybe>; surcharges?: Maybe>; updateShippingAddress?: Maybe; updateBillingAddress?: Maybe; note?: Maybe; refund?: Maybe; options?: Maybe; }; export type ModifyOrderOptions = { freezePromotions?: Maybe; recalculateShipping?: Maybe; }; export type ModifyOrderResult = Order | NoChangesSpecifiedError | OrderModificationStateError | PaymentMethodMissingError | RefundPaymentIdMissingError | OrderLimitError | NegativeQuantityError | InsufficientStockError; export type MoveCollectionInput = { collectionId: Scalars['ID']; parentId: Scalars['ID']; index: Scalars['Int']; }; /** Returned if an operation has specified OrderLines from multiple Orders */ export type MultipleOrderError = ErrorResult & { __typename?: 'MultipleOrderError'; errorCode: ErrorCode; message: Scalars['String']; }; export type Mutation = { __typename?: 'Mutation'; /** Create a new Administrator */ createAdministrator: Administrator; /** Update an existing Administrator */ updateAdministrator: Administrator; /** Update the active (currently logged-in) Administrator */ updateActiveAdministrator: Administrator; /** Delete an Administrator */ deleteAdministrator: DeletionResponse; /** Assign a Role to an Administrator */ assignRoleToAdministrator: Administrator; /** Create a new Asset */ createAssets: Array; /** Update an existing Asset */ updateAsset: Asset; /** Delete an Asset */ deleteAsset: DeletionResponse; /** Delete multiple Assets */ deleteAssets: DeletionResponse; /** Assign assets to channel */ assignAssetsToChannel: Array; /** Authenticates the user using the native authentication strategy. This mutation is an alias for `authenticate({ native: { ... }})` */ login: NativeAuthenticationResult; /** Authenticates the user using a named authentication strategy */ authenticate: AuthenticationResult; logout: Success; /** Create a new Channel */ createChannel: CreateChannelResult; /** Update an existing Channel */ updateChannel: UpdateChannelResult; /** Delete a Channel */ deleteChannel: DeletionResponse; /** Create a new Collection */ createCollection: Collection; /** Update an existing Collection */ updateCollection: Collection; /** Delete a Collection and all of its descendants */ deleteCollection: DeletionResponse; /** Move a Collection to a different parent or index */ moveCollection: Collection; /** Create a new Country */ createCountry: Country; /** Update an existing Country */ updateCountry: Country; /** Delete a Country */ deleteCountry: DeletionResponse; /** Create a new CustomerGroup */ createCustomerGroup: CustomerGroup; /** Update an existing CustomerGroup */ updateCustomerGroup: CustomerGroup; /** Delete a CustomerGroup */ deleteCustomerGroup: DeletionResponse; /** Add Customers to a CustomerGroup */ addCustomersToGroup: CustomerGroup; /** Remove Customers from a CustomerGroup */ removeCustomersFromGroup: CustomerGroup; /** Create a new Customer. If a password is provided, a new User will also be created an linked to the Customer. */ createCustomer: CreateCustomerResult; /** Update an existing Customer */ updateCustomer: UpdateCustomerResult; /** Delete a Customer */ deleteCustomer: DeletionResponse; /** Create a new Address and associate it with the Customer specified by customerId */ createCustomerAddress: Address; /** Update an existing Address */ updateCustomerAddress: Address; /** Update an existing Address */ deleteCustomerAddress: Success; addNoteToCustomer: Customer; updateCustomerNote: HistoryEntry; deleteCustomerNote: DeletionResponse; /** Create a new Facet */ createFacet: Facet; /** Update an existing Facet */ updateFacet: Facet; /** Delete an existing Facet */ deleteFacet: DeletionResponse; /** Create one or more FacetValues */ createFacetValues: Array; /** Update one or more FacetValues */ updateFacetValues: Array; /** Delete one or more FacetValues */ deleteFacetValues: Array; updateGlobalSettings: UpdateGlobalSettingsResult; importProducts?: Maybe; /** Remove all settled jobs in the given queues older than the given date. Returns the number of jobs deleted. */ removeSettledJobs: Scalars['Int']; cancelJob: Job; flushBufferedJobs: Success; settlePayment: SettlePaymentResult; addFulfillmentToOrder: AddFulfillmentToOrderResult; cancelOrder: CancelOrderResult; refundOrder: RefundOrderResult; settleRefund: SettleRefundResult; addNoteToOrder: Order; updateOrderNote: HistoryEntry; deleteOrderNote: DeletionResponse; transitionOrderToState?: Maybe; transitionFulfillmentToState: TransitionFulfillmentToStateResult; transitionPaymentToState: TransitionPaymentToStateResult; setOrderCustomFields?: Maybe; /** * Allows an Order to be modified after it has been completed by the Customer. The Order must first * be in the `Modifying` state. */ modifyOrder: ModifyOrderResult; /** * Used to manually create a new Payment against an Order. * This can be used by an Administrator when an Order is in the ArrangingPayment state. * * It is also used when a completed Order * has been modified (using `modifyOrder`) and the price has increased. The extra payment * can then be manually arranged by the administrator, and the details used to create a new * Payment. */ addManualPaymentToOrder: AddManualPaymentToOrderResult; /** Create existing PaymentMethod */ createPaymentMethod: PaymentMethod; /** Update an existing PaymentMethod */ updatePaymentMethod: PaymentMethod; /** Delete a PaymentMethod */ deletePaymentMethod: DeletionResponse; /** Create a new ProductOptionGroup */ createProductOptionGroup: ProductOptionGroup; /** Update an existing ProductOptionGroup */ updateProductOptionGroup: ProductOptionGroup; /** Create a new ProductOption within a ProductOptionGroup */ createProductOption: ProductOption; /** Create a new ProductOption within a ProductOptionGroup */ updateProductOption: ProductOption; reindex: Job; runPendingSearchIndexUpdates: Success; /** Create a new Product */ createProduct: Product; /** Update an existing Product */ updateProduct: Product; /** Delete a Product */ deleteProduct: DeletionResponse; /** Add an OptionGroup to a Product */ addOptionGroupToProduct: Product; /** Remove an OptionGroup from a Product */ removeOptionGroupFromProduct: RemoveOptionGroupFromProductResult; /** Create a set of ProductVariants based on the OptionGroups assigned to the given Product */ createProductVariants: Array>; /** Update existing ProductVariants */ updateProductVariants: Array>; /** Delete a ProductVariant */ deleteProductVariant: DeletionResponse; /** Assigns all ProductVariants of Product to the specified Channel */ assignProductsToChannel: Array; /** Removes all ProductVariants of Product from the specified Channel */ removeProductsFromChannel: Array; /** Assigns ProductVariants to the specified Channel */ assignProductVariantsToChannel: Array; /** Removes ProductVariants from the specified Channel */ removeProductVariantsFromChannel: Array; createPromotion: CreatePromotionResult; updatePromotion: UpdatePromotionResult; deletePromotion: DeletionResponse; /** Assigns Promotions to the specified Channel */ assignPromotionsToChannel: Array; /** Removes Promotions from the specified Channel */ removePromotionsFromChannel: Array; /** Create a new Role */ createRole: Role; /** Update an existing Role */ updateRole: Role; /** Delete an existing Role */ deleteRole: DeletionResponse; /** Create a new ShippingMethod */ createShippingMethod: ShippingMethod; /** Update an existing ShippingMethod */ updateShippingMethod: ShippingMethod; /** Delete a ShippingMethod */ deleteShippingMethod: DeletionResponse; /** Create a new Tag */ createTag: Tag; /** Update an existing Tag */ updateTag: Tag; /** Delete an existing Tag */ deleteTag: DeletionResponse; /** Create a new TaxCategory */ createTaxCategory: TaxCategory; /** Update an existing TaxCategory */ updateTaxCategory: TaxCategory; /** Deletes a TaxCategory */ deleteTaxCategory: DeletionResponse; /** Create a new TaxRate */ createTaxRate: TaxRate; /** Update an existing TaxRate */ updateTaxRate: TaxRate; /** Delete a TaxRate */ deleteTaxRate: DeletionResponse; /** Create a new Zone */ createZone: Zone; /** Update an existing Zone */ updateZone: Zone; /** Delete a Zone */ deleteZone: DeletionResponse; /** Add members to a Zone */ addMembersToZone: Zone; /** Remove members from a Zone */ removeMembersFromZone: Zone; }; export type MutationCreateAdministratorArgs = { input: CreateAdministratorInput; }; export type MutationUpdateAdministratorArgs = { input: UpdateAdministratorInput; }; export type MutationUpdateActiveAdministratorArgs = { input: UpdateActiveAdministratorInput; }; export type MutationDeleteAdministratorArgs = { id: Scalars['ID']; }; export type MutationAssignRoleToAdministratorArgs = { administratorId: Scalars['ID']; roleId: Scalars['ID']; }; export type MutationCreateAssetsArgs = { input: Array; }; export type MutationUpdateAssetArgs = { input: UpdateAssetInput; }; export type MutationDeleteAssetArgs = { input: DeleteAssetInput; }; export type MutationDeleteAssetsArgs = { input: DeleteAssetsInput; }; export type MutationAssignAssetsToChannelArgs = { input: AssignAssetsToChannelInput; }; export type MutationLoginArgs = { username: Scalars['String']; password: Scalars['String']; rememberMe?: Maybe; }; export type MutationAuthenticateArgs = { input: AuthenticationInput; rememberMe?: Maybe; }; export type MutationCreateChannelArgs = { input: CreateChannelInput; }; export type MutationUpdateChannelArgs = { input: UpdateChannelInput; }; export type MutationDeleteChannelArgs = { id: Scalars['ID']; }; export type MutationCreateCollectionArgs = { input: CreateCollectionInput; }; export type MutationUpdateCollectionArgs = { input: UpdateCollectionInput; }; export type MutationDeleteCollectionArgs = { id: Scalars['ID']; }; export type MutationMoveCollectionArgs = { input: MoveCollectionInput; }; export type MutationCreateCountryArgs = { input: CreateCountryInput; }; export type MutationUpdateCountryArgs = { input: UpdateCountryInput; }; export type MutationDeleteCountryArgs = { id: Scalars['ID']; }; export type MutationCreateCustomerGroupArgs = { input: CreateCustomerGroupInput; }; export type MutationUpdateCustomerGroupArgs = { input: UpdateCustomerGroupInput; }; export type MutationDeleteCustomerGroupArgs = { id: Scalars['ID']; }; export type MutationAddCustomersToGroupArgs = { customerGroupId: Scalars['ID']; customerIds: Array; }; export type MutationRemoveCustomersFromGroupArgs = { customerGroupId: Scalars['ID']; customerIds: Array; }; export type MutationCreateCustomerArgs = { input: CreateCustomerInput; password?: Maybe; }; export type MutationUpdateCustomerArgs = { input: UpdateCustomerInput; }; export type MutationDeleteCustomerArgs = { id: Scalars['ID']; }; export type MutationCreateCustomerAddressArgs = { customerId: Scalars['ID']; input: CreateAddressInput; }; export type MutationUpdateCustomerAddressArgs = { input: UpdateAddressInput; }; export type MutationDeleteCustomerAddressArgs = { id: Scalars['ID']; }; export type MutationAddNoteToCustomerArgs = { input: AddNoteToCustomerInput; }; export type MutationUpdateCustomerNoteArgs = { input: UpdateCustomerNoteInput; }; export type MutationDeleteCustomerNoteArgs = { id: Scalars['ID']; }; export type MutationCreateFacetArgs = { input: CreateFacetInput; }; export type MutationUpdateFacetArgs = { input: UpdateFacetInput; }; export type MutationDeleteFacetArgs = { id: Scalars['ID']; force?: Maybe; }; export type MutationCreateFacetValuesArgs = { input: Array; }; export type MutationUpdateFacetValuesArgs = { input: Array; }; export type MutationDeleteFacetValuesArgs = { ids: Array; force?: Maybe; }; export type MutationUpdateGlobalSettingsArgs = { input: UpdateGlobalSettingsInput; }; export type MutationImportProductsArgs = { csvFile: Scalars['Upload']; }; export type MutationRemoveSettledJobsArgs = { queueNames?: Maybe>; olderThan?: Maybe; }; export type MutationCancelJobArgs = { jobId: Scalars['ID']; }; export type MutationFlushBufferedJobsArgs = { bufferIds?: Maybe>; }; export type MutationSettlePaymentArgs = { id: Scalars['ID']; }; export type MutationAddFulfillmentToOrderArgs = { input: FulfillOrderInput; }; export type MutationCancelOrderArgs = { input: CancelOrderInput; }; export type MutationRefundOrderArgs = { input: RefundOrderInput; }; export type MutationSettleRefundArgs = { input: SettleRefundInput; }; export type MutationAddNoteToOrderArgs = { input: AddNoteToOrderInput; }; export type MutationUpdateOrderNoteArgs = { input: UpdateOrderNoteInput; }; export type MutationDeleteOrderNoteArgs = { id: Scalars['ID']; }; export type MutationTransitionOrderToStateArgs = { id: Scalars['ID']; state: Scalars['String']; }; export type MutationTransitionFulfillmentToStateArgs = { id: Scalars['ID']; state: Scalars['String']; }; export type MutationTransitionPaymentToStateArgs = { id: Scalars['ID']; state: Scalars['String']; }; export type MutationSetOrderCustomFieldsArgs = { input: UpdateOrderInput; }; export type MutationModifyOrderArgs = { input: ModifyOrderInput; }; export type MutationAddManualPaymentToOrderArgs = { input: ManualPaymentInput; }; export type MutationCreatePaymentMethodArgs = { input: CreatePaymentMethodInput; }; export type MutationUpdatePaymentMethodArgs = { input: UpdatePaymentMethodInput; }; export type MutationDeletePaymentMethodArgs = { id: Scalars['ID']; force?: Maybe; }; export type MutationCreateProductOptionGroupArgs = { input: CreateProductOptionGroupInput; }; export type MutationUpdateProductOptionGroupArgs = { input: UpdateProductOptionGroupInput; }; export type MutationCreateProductOptionArgs = { input: CreateProductOptionInput; }; export type MutationUpdateProductOptionArgs = { input: UpdateProductOptionInput; }; export type MutationCreateProductArgs = { input: CreateProductInput; }; export type MutationUpdateProductArgs = { input: UpdateProductInput; }; export type MutationDeleteProductArgs = { id: Scalars['ID']; }; export type MutationAddOptionGroupToProductArgs = { productId: Scalars['ID']; optionGroupId: Scalars['ID']; }; export type MutationRemoveOptionGroupFromProductArgs = { productId: Scalars['ID']; optionGroupId: Scalars['ID']; }; export type MutationCreateProductVariantsArgs = { input: Array; }; export type MutationUpdateProductVariantsArgs = { input: Array; }; export type MutationDeleteProductVariantArgs = { id: Scalars['ID']; }; export type MutationAssignProductsToChannelArgs = { input: AssignProductsToChannelInput; }; export type MutationRemoveProductsFromChannelArgs = { input: RemoveProductsFromChannelInput; }; export type MutationAssignProductVariantsToChannelArgs = { input: AssignProductVariantsToChannelInput; }; export type MutationRemoveProductVariantsFromChannelArgs = { input: RemoveProductVariantsFromChannelInput; }; export type MutationCreatePromotionArgs = { input: CreatePromotionInput; }; export type MutationUpdatePromotionArgs = { input: UpdatePromotionInput; }; export type MutationDeletePromotionArgs = { id: Scalars['ID']; }; export type MutationAssignPromotionsToChannelArgs = { input: AssignPromotionsToChannelInput; }; export type MutationRemovePromotionsFromChannelArgs = { input: RemovePromotionsFromChannelInput; }; export type MutationCreateRoleArgs = { input: CreateRoleInput; }; export type MutationUpdateRoleArgs = { input: UpdateRoleInput; }; export type MutationDeleteRoleArgs = { id: Scalars['ID']; }; export type MutationCreateShippingMethodArgs = { input: CreateShippingMethodInput; }; export type MutationUpdateShippingMethodArgs = { input: UpdateShippingMethodInput; }; export type MutationDeleteShippingMethodArgs = { id: Scalars['ID']; }; export type MutationCreateTagArgs = { input: CreateTagInput; }; export type MutationUpdateTagArgs = { input: UpdateTagInput; }; export type MutationDeleteTagArgs = { id: Scalars['ID']; }; export type MutationCreateTaxCategoryArgs = { input: CreateTaxCategoryInput; }; export type MutationUpdateTaxCategoryArgs = { input: UpdateTaxCategoryInput; }; export type MutationDeleteTaxCategoryArgs = { id: Scalars['ID']; }; export type MutationCreateTaxRateArgs = { input: CreateTaxRateInput; }; export type MutationUpdateTaxRateArgs = { input: UpdateTaxRateInput; }; export type MutationDeleteTaxRateArgs = { id: Scalars['ID']; }; export type MutationCreateZoneArgs = { input: CreateZoneInput; }; export type MutationUpdateZoneArgs = { input: UpdateZoneInput; }; export type MutationDeleteZoneArgs = { id: Scalars['ID']; }; export type MutationAddMembersToZoneArgs = { zoneId: Scalars['ID']; memberIds: Array; }; export type MutationRemoveMembersFromZoneArgs = { zoneId: Scalars['ID']; memberIds: Array; }; export type NativeAuthInput = { username: Scalars['String']; password: Scalars['String']; }; /** Returned when attempting an operation that relies on the NativeAuthStrategy, if that strategy is not configured. */ export type NativeAuthStrategyError = ErrorResult & { __typename?: 'NativeAuthStrategyError'; errorCode: ErrorCode; message: Scalars['String']; }; export type NativeAuthenticationResult = CurrentUser | InvalidCredentialsError | NativeAuthStrategyError; /** Returned when attempting to set a negative OrderLine quantity. */ export type NegativeQuantityError = ErrorResult & { __typename?: 'NegativeQuantityError'; errorCode: ErrorCode; message: Scalars['String']; }; /** Returned when a call to modifyOrder fails to specify any changes */ export type NoChangesSpecifiedError = ErrorResult & { __typename?: 'NoChangesSpecifiedError'; errorCode: ErrorCode; message: Scalars['String']; }; export type Node = { id: Scalars['ID']; }; /** Returned if an attempting to refund an Order but neither items nor shipping refund was specified */ export type NothingToRefundError = ErrorResult & { __typename?: 'NothingToRefundError'; errorCode: ErrorCode; message: Scalars['String']; }; /** Operators for filtering on a Int or Float field */ export type NumberOperators = { eq?: Maybe; lt?: Maybe; lte?: Maybe; gt?: Maybe; gte?: Maybe; between?: Maybe; }; export type NumberRange = { start: Scalars['Float']; end: Scalars['Float']; }; export type Order = Node & { __typename?: 'Order'; nextStates: Array; modifications: Array; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; /** * The date & time that the Order was placed, i.e. the Customer * completed the checkout and the Order is no longer "active" */ orderPlacedAt?: Maybe; /** A unique code for the Order */ code: Scalars['String']; state: Scalars['String']; /** An order is active as long as the payment process has not been completed */ active: Scalars['Boolean']; customer?: Maybe; shippingAddress?: Maybe; billingAddress?: Maybe; lines: Array; /** * Surcharges are arbitrary modifications to the Order total which are neither * ProductVariants nor discounts resulting from applied Promotions. For example, * one-off discounts based on customer interaction, or surcharges based on payment * methods. */ surcharges: Array; discounts: Array; /** An array of all coupon codes applied to the Order */ couponCodes: Array; /** Promotions applied to the order. Only gets populated after the payment process has completed. */ promotions: Array; payments?: Maybe>; fulfillments?: Maybe>; totalQuantity: Scalars['Int']; /** * The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level * discounts which have been prorated (proportionally distributed) amongst the OrderItems. * To get a total of all OrderLines which does not account for prorated discounts, use the * sum of `OrderLine.discountedLinePrice` values. */ subTotal: Scalars['Int']; /** Same as subTotal, but inclusive of tax */ subTotalWithTax: Scalars['Int']; currencyCode: CurrencyCode; shippingLines: Array; shipping: Scalars['Int']; shippingWithTax: Scalars['Int']; /** Equal to subTotal plus shipping */ total: Scalars['Int']; /** The final payable amount. Equal to subTotalWithTax plus shippingWithTax */ totalWithTax: Scalars['Int']; /** A summary of the taxes being applied to this Order */ taxSummary: Array; history: HistoryEntryList; customFields?: Maybe; }; export type OrderHistoryArgs = { options?: Maybe; }; export type OrderAddress = { __typename?: 'OrderAddress'; fullName?: Maybe; company?: Maybe; streetLine1?: Maybe; streetLine2?: Maybe; city?: Maybe; province?: Maybe; postalCode?: Maybe; country?: Maybe; countryCode?: Maybe; phoneNumber?: Maybe; customFields?: Maybe; }; export type OrderFilterParameter = { customerLastName?: Maybe; id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; orderPlacedAt?: Maybe; code?: Maybe; state?: Maybe; active?: Maybe; totalQuantity?: Maybe; subTotal?: Maybe; subTotalWithTax?: Maybe; currencyCode?: Maybe; shipping?: Maybe; shippingWithTax?: Maybe; total?: Maybe; totalWithTax?: Maybe; }; export type OrderItem = Node & { __typename?: 'OrderItem'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; cancelled: Scalars['Boolean']; /** The price of a single unit, excluding tax and discounts */ unitPrice: Scalars['Int']; /** The price of a single unit, including tax but excluding discounts */ unitPriceWithTax: Scalars['Int']; /** * The price of a single unit including discounts, excluding tax. * * If Order-level discounts have been applied, this will not be the * actual taxable unit price (see `proratedUnitPrice`), but is generally the * correct price to display to customers to avoid confusion * about the internal handling of distributed Order-level discounts. */ discountedUnitPrice: Scalars['Int']; /** The price of a single unit including discounts and tax */ discountedUnitPriceWithTax: Scalars['Int']; /** * The actual unit price, taking into account both item discounts _and_ prorated (proportionally-distributed) * Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax * and refund calculations. */ proratedUnitPrice: Scalars['Int']; /** The proratedUnitPrice including tax */ proratedUnitPriceWithTax: Scalars['Int']; unitTax: Scalars['Int']; taxRate: Scalars['Float']; adjustments: Array; taxLines: Array; fulfillment?: Maybe; refundId?: Maybe; }; /** Returned when the maximum order size limit has been reached. */ export type OrderLimitError = ErrorResult & { __typename?: 'OrderLimitError'; errorCode: ErrorCode; message: Scalars['String']; maxItems: Scalars['Int']; }; export type OrderLine = Node & { __typename?: 'OrderLine'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; productVariant: ProductVariant; featuredAsset?: Maybe; /** The price of a single unit, excluding tax and discounts */ unitPrice: Scalars['Int']; /** The price of a single unit, including tax but excluding discounts */ unitPriceWithTax: Scalars['Int']; /** Non-zero if the unitPrice has changed since it was initially added to Order */ unitPriceChangeSinceAdded: Scalars['Int']; /** Non-zero if the unitPriceWithTax has changed since it was initially added to Order */ unitPriceWithTaxChangeSinceAdded: Scalars['Int']; /** * The price of a single unit including discounts, excluding tax. * * If Order-level discounts have been applied, this will not be the * actual taxable unit price (see `proratedUnitPrice`), but is generally the * correct price to display to customers to avoid confusion * about the internal handling of distributed Order-level discounts. */ discountedUnitPrice: Scalars['Int']; /** The price of a single unit including discounts and tax */ discountedUnitPriceWithTax: Scalars['Int']; /** * The actual unit price, taking into account both item discounts _and_ prorated (proportionally-distributed) * Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax * and refund calculations. */ proratedUnitPrice: Scalars['Int']; /** The proratedUnitPrice including tax */ proratedUnitPriceWithTax: Scalars['Int']; quantity: Scalars['Int']; items: Array; taxRate: Scalars['Float']; /** The total price of the line excluding tax and discounts. */ linePrice: Scalars['Int']; /** The total price of the line including tax but excluding discounts. */ linePriceWithTax: Scalars['Int']; /** The price of the line including discounts, excluding tax */ discountedLinePrice: Scalars['Int']; /** The price of the line including discounts and tax */ discountedLinePriceWithTax: Scalars['Int']; /** * The actual line price, taking into account both item discounts _and_ prorated (proportionally-distributed) * Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax * and refund calculations. */ proratedLinePrice: Scalars['Int']; /** The proratedLinePrice including tax */ proratedLinePriceWithTax: Scalars['Int']; /** The total tax on this line */ lineTax: Scalars['Int']; discounts: Array; taxLines: Array; order: Order; customFields?: Maybe; }; export type OrderLineInput = { orderLineId: Scalars['ID']; quantity: Scalars['Int']; }; export type OrderList = PaginatedList & { __typename?: 'OrderList'; items: Array; totalItems: Scalars['Int']; }; export type OrderListOptions = { /** Skips the first n results, for use in pagination */ skip?: Maybe; /** Takes n results, for use in pagination */ take?: Maybe; /** Specifies which properties to sort the results by */ sort?: Maybe; /** Allows the results to be filtered */ filter?: Maybe; /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */ filterOperator?: Maybe; }; export type OrderModification = Node & { __typename?: 'OrderModification'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; priceChange: Scalars['Int']; note: Scalars['String']; orderItems?: Maybe>; surcharges?: Maybe>; payment?: Maybe; refund?: Maybe; isSettled: Scalars['Boolean']; }; /** Returned when attempting to modify the contents of an Order that is not in the `Modifying` state. */ export type OrderModificationStateError = ErrorResult & { __typename?: 'OrderModificationStateError'; errorCode: ErrorCode; message: Scalars['String']; }; export type OrderProcessState = { __typename?: 'OrderProcessState'; name: Scalars['String']; to: Array; }; export type OrderSortParameter = { customerLastName?: Maybe; id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; orderPlacedAt?: Maybe; code?: Maybe; state?: Maybe; totalQuantity?: Maybe; subTotal?: Maybe; subTotalWithTax?: Maybe; shipping?: Maybe; shippingWithTax?: Maybe; total?: Maybe; totalWithTax?: Maybe; }; /** Returned if there is an error in transitioning the Order state */ export type OrderStateTransitionError = ErrorResult & { __typename?: 'OrderStateTransitionError'; errorCode: ErrorCode; message: Scalars['String']; transitionError: Scalars['String']; fromState: Scalars['String']; toState: Scalars['String']; }; /** * A summary of the taxes being applied to this order, grouped * by taxRate. */ export type OrderTaxSummary = { __typename?: 'OrderTaxSummary'; /** A description of this tax */ description: Scalars['String']; /** The taxRate as a percentage */ taxRate: Scalars['Float']; /** The total net price or OrderItems to which this taxRate applies */ taxBase: Scalars['Int']; /** The total tax being applied to the Order at this taxRate */ taxTotal: Scalars['Int']; }; export type PaginatedList = { items: Array; totalItems: Scalars['Int']; }; export type Payment = Node & { __typename?: 'Payment'; nextStates: Array; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; method: Scalars['String']; amount: Scalars['Int']; state: Scalars['String']; transactionId?: Maybe; errorMessage?: Maybe; refunds: Array; metadata?: Maybe; }; export type PaymentMethod = Node & { __typename?: 'PaymentMethod'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; name: Scalars['String']; code: Scalars['String']; description: Scalars['String']; enabled: Scalars['Boolean']; checker?: Maybe; handler: ConfigurableOperation; customFields?: Maybe; }; export type PaymentMethodFilterParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; name?: Maybe; code?: Maybe; description?: Maybe; enabled?: Maybe; }; export type PaymentMethodList = PaginatedList & { __typename?: 'PaymentMethodList'; items: Array; totalItems: Scalars['Int']; }; export type PaymentMethodListOptions = { /** Skips the first n results, for use in pagination */ skip?: Maybe; /** Takes n results, for use in pagination */ take?: Maybe; /** Specifies which properties to sort the results by */ sort?: Maybe; /** Allows the results to be filtered */ filter?: Maybe; /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */ filterOperator?: Maybe; }; /** * Returned when a call to modifyOrder fails to include a paymentMethod even * though the price has increased as a result of the changes. */ export type PaymentMethodMissingError = ErrorResult & { __typename?: 'PaymentMethodMissingError'; errorCode: ErrorCode; message: Scalars['String']; }; export type PaymentMethodQuote = { __typename?: 'PaymentMethodQuote'; id: Scalars['ID']; code: Scalars['String']; name: Scalars['String']; description: Scalars['String']; isEligible: Scalars['Boolean']; eligibilityMessage?: Maybe; customFields?: Maybe; }; export type PaymentMethodSortParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; name?: Maybe; code?: Maybe; description?: Maybe; }; /** Returned if an attempting to refund a Payment against OrderLines from a different Order */ export type PaymentOrderMismatchError = ErrorResult & { __typename?: 'PaymentOrderMismatchError'; errorCode: ErrorCode; message: Scalars['String']; }; /** Returned when there is an error in transitioning the Payment state */ export type PaymentStateTransitionError = ErrorResult & { __typename?: 'PaymentStateTransitionError'; errorCode: ErrorCode; message: Scalars['String']; transitionError: Scalars['String']; fromState: Scalars['String']; toState: Scalars['String']; }; /** * @description * Permissions for administrators and customers. Used to control access to * GraphQL resolvers via the {@link Allow} decorator. * * @docsCategory common */ export enum Permission { /** Authenticated means simply that the user is logged in */ Authenticated = 'Authenticated', /** SuperAdmin has unrestricted access to all operations */ SuperAdmin = 'SuperAdmin', /** Owner means the user owns this entity, e.g. a Customer's own Order */ Owner = 'Owner', /** Public means any unauthenticated user may perform the operation */ Public = 'Public', /** Grants permission to update GlobalSettings */ UpdateGlobalSettings = 'UpdateGlobalSettings', /** Grants permission to create Products, Facets, Assets, Collections */ CreateCatalog = 'CreateCatalog', /** Grants permission to read Products, Facets, Assets, Collections */ ReadCatalog = 'ReadCatalog', /** Grants permission to update Products, Facets, Assets, Collections */ UpdateCatalog = 'UpdateCatalog', /** Grants permission to delete Products, Facets, Assets, Collections */ DeleteCatalog = 'DeleteCatalog', /** Grants permission to create PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */ CreateSettings = 'CreateSettings', /** Grants permission to read PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */ ReadSettings = 'ReadSettings', /** Grants permission to update PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */ UpdateSettings = 'UpdateSettings', /** Grants permission to delete PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */ DeleteSettings = 'DeleteSettings', /** Grants permission to create Administrator */ CreateAdministrator = 'CreateAdministrator', /** Grants permission to read Administrator */ ReadAdministrator = 'ReadAdministrator', /** Grants permission to update Administrator */ UpdateAdministrator = 'UpdateAdministrator', /** Grants permission to delete Administrator */ DeleteAdministrator = 'DeleteAdministrator', /** Grants permission to create Asset */ CreateAsset = 'CreateAsset', /** Grants permission to read Asset */ ReadAsset = 'ReadAsset', /** Grants permission to update Asset */ UpdateAsset = 'UpdateAsset', /** Grants permission to delete Asset */ DeleteAsset = 'DeleteAsset', /** Grants permission to create Channel */ CreateChannel = 'CreateChannel', /** Grants permission to read Channel */ ReadChannel = 'ReadChannel', /** Grants permission to update Channel */ UpdateChannel = 'UpdateChannel', /** Grants permission to delete Channel */ DeleteChannel = 'DeleteChannel', /** Grants permission to create Collection */ CreateCollection = 'CreateCollection', /** Grants permission to read Collection */ ReadCollection = 'ReadCollection', /** Grants permission to update Collection */ UpdateCollection = 'UpdateCollection', /** Grants permission to delete Collection */ DeleteCollection = 'DeleteCollection', /** Grants permission to create Country */ CreateCountry = 'CreateCountry', /** Grants permission to read Country */ ReadCountry = 'ReadCountry', /** Grants permission to update Country */ UpdateCountry = 'UpdateCountry', /** Grants permission to delete Country */ DeleteCountry = 'DeleteCountry', /** Grants permission to create Customer */ CreateCustomer = 'CreateCustomer', /** Grants permission to read Customer */ ReadCustomer = 'ReadCustomer', /** Grants permission to update Customer */ UpdateCustomer = 'UpdateCustomer', /** Grants permission to delete Customer */ DeleteCustomer = 'DeleteCustomer', /** Grants permission to create CustomerGroup */ CreateCustomerGroup = 'CreateCustomerGroup', /** Grants permission to read CustomerGroup */ ReadCustomerGroup = 'ReadCustomerGroup', /** Grants permission to update CustomerGroup */ UpdateCustomerGroup = 'UpdateCustomerGroup', /** Grants permission to delete CustomerGroup */ DeleteCustomerGroup = 'DeleteCustomerGroup', /** Grants permission to create Facet */ CreateFacet = 'CreateFacet', /** Grants permission to read Facet */ ReadFacet = 'ReadFacet', /** Grants permission to update Facet */ UpdateFacet = 'UpdateFacet', /** Grants permission to delete Facet */ DeleteFacet = 'DeleteFacet', /** Grants permission to create Order */ CreateOrder = 'CreateOrder', /** Grants permission to read Order */ ReadOrder = 'ReadOrder', /** Grants permission to update Order */ UpdateOrder = 'UpdateOrder', /** Grants permission to delete Order */ DeleteOrder = 'DeleteOrder', /** Grants permission to create PaymentMethod */ CreatePaymentMethod = 'CreatePaymentMethod', /** Grants permission to read PaymentMethod */ ReadPaymentMethod = 'ReadPaymentMethod', /** Grants permission to update PaymentMethod */ UpdatePaymentMethod = 'UpdatePaymentMethod', /** Grants permission to delete PaymentMethod */ DeletePaymentMethod = 'DeletePaymentMethod', /** Grants permission to create Product */ CreateProduct = 'CreateProduct', /** Grants permission to read Product */ ReadProduct = 'ReadProduct', /** Grants permission to update Product */ UpdateProduct = 'UpdateProduct', /** Grants permission to delete Product */ DeleteProduct = 'DeleteProduct', /** Grants permission to create Promotion */ CreatePromotion = 'CreatePromotion', /** Grants permission to read Promotion */ ReadPromotion = 'ReadPromotion', /** Grants permission to update Promotion */ UpdatePromotion = 'UpdatePromotion', /** Grants permission to delete Promotion */ DeletePromotion = 'DeletePromotion', /** Grants permission to create ShippingMethod */ CreateShippingMethod = 'CreateShippingMethod', /** Grants permission to read ShippingMethod */ ReadShippingMethod = 'ReadShippingMethod', /** Grants permission to update ShippingMethod */ UpdateShippingMethod = 'UpdateShippingMethod', /** Grants permission to delete ShippingMethod */ DeleteShippingMethod = 'DeleteShippingMethod', /** Grants permission to create Tag */ CreateTag = 'CreateTag', /** Grants permission to read Tag */ ReadTag = 'ReadTag', /** Grants permission to update Tag */ UpdateTag = 'UpdateTag', /** Grants permission to delete Tag */ DeleteTag = 'DeleteTag', /** Grants permission to create TaxCategory */ CreateTaxCategory = 'CreateTaxCategory', /** Grants permission to read TaxCategory */ ReadTaxCategory = 'ReadTaxCategory', /** Grants permission to update TaxCategory */ UpdateTaxCategory = 'UpdateTaxCategory', /** Grants permission to delete TaxCategory */ DeleteTaxCategory = 'DeleteTaxCategory', /** Grants permission to create TaxRate */ CreateTaxRate = 'CreateTaxRate', /** Grants permission to read TaxRate */ ReadTaxRate = 'ReadTaxRate', /** Grants permission to update TaxRate */ UpdateTaxRate = 'UpdateTaxRate', /** Grants permission to delete TaxRate */ DeleteTaxRate = 'DeleteTaxRate', /** Grants permission to create System */ CreateSystem = 'CreateSystem', /** Grants permission to read System */ ReadSystem = 'ReadSystem', /** Grants permission to update System */ UpdateSystem = 'UpdateSystem', /** Grants permission to delete System */ DeleteSystem = 'DeleteSystem', /** Grants permission to create Zone */ CreateZone = 'CreateZone', /** Grants permission to read Zone */ ReadZone = 'ReadZone', /** Grants permission to update Zone */ UpdateZone = 'UpdateZone', /** Grants permission to delete Zone */ DeleteZone = 'DeleteZone' } export type PermissionDefinition = { __typename?: 'PermissionDefinition'; name: Scalars['String']; description: Scalars['String']; assignable: Scalars['Boolean']; }; /** The price range where the result has more than one price */ export type PriceRange = { __typename?: 'PriceRange'; min: Scalars['Int']; max: Scalars['Int']; }; export type Product = Node & { __typename?: 'Product'; enabled: Scalars['Boolean']; channels: Array; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; languageCode: LanguageCode; name: Scalars['String']; slug: Scalars['String']; description: Scalars['String']; featuredAsset?: Maybe; assets: Array; /** Returns all ProductVariants */ variants: Array; /** Returns a paginated, sortable, filterable list of ProductVariants */ variantList: ProductVariantList; optionGroups: Array; facetValues: Array; translations: Array; collections: Array; customFields?: Maybe; }; export type ProductVariantListArgs = { options?: Maybe; }; export type ProductFilterParameter = { enabled?: Maybe; id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; languageCode?: Maybe; name?: Maybe; slug?: Maybe; description?: Maybe; }; export type ProductList = PaginatedList & { __typename?: 'ProductList'; items: Array; totalItems: Scalars['Int']; }; export type ProductListOptions = { /** Skips the first n results, for use in pagination */ skip?: Maybe; /** Takes n results, for use in pagination */ take?: Maybe; /** Specifies which properties to sort the results by */ sort?: Maybe; /** Allows the results to be filtered */ filter?: Maybe; /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */ filterOperator?: Maybe; }; export type ProductOption = Node & { __typename?: 'ProductOption'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; languageCode: LanguageCode; code: Scalars['String']; name: Scalars['String']; groupId: Scalars['ID']; group: ProductOptionGroup; translations: Array; customFields?: Maybe; }; export type ProductOptionGroup = Node & { __typename?: 'ProductOptionGroup'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; languageCode: LanguageCode; code: Scalars['String']; name: Scalars['String']; options: Array; translations: Array; customFields?: Maybe; }; export type ProductOptionGroupTranslation = { __typename?: 'ProductOptionGroupTranslation'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; languageCode: LanguageCode; name: Scalars['String']; }; export type ProductOptionGroupTranslationInput = { id?: Maybe; languageCode: LanguageCode; name?: Maybe; customFields?: Maybe; }; export type ProductOptionInUseError = ErrorResult & { __typename?: 'ProductOptionInUseError'; errorCode: ErrorCode; message: Scalars['String']; optionGroupCode: Scalars['String']; productVariantCount: Scalars['Int']; }; export type ProductOptionTranslation = { __typename?: 'ProductOptionTranslation'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; languageCode: LanguageCode; name: Scalars['String']; }; export type ProductOptionTranslationInput = { id?: Maybe; languageCode: LanguageCode; name?: Maybe; customFields?: Maybe; }; export type ProductSortParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; name?: Maybe; slug?: Maybe; description?: Maybe; }; export type ProductTranslation = { __typename?: 'ProductTranslation'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; languageCode: LanguageCode; name: Scalars['String']; slug: Scalars['String']; description: Scalars['String']; }; export type ProductTranslationInput = { id?: Maybe; languageCode: LanguageCode; name?: Maybe; slug?: Maybe; description?: Maybe; customFields?: Maybe; }; export type ProductVariant = Node & { __typename?: 'ProductVariant'; enabled: Scalars['Boolean']; trackInventory: GlobalFlag; stockOnHand: Scalars['Int']; stockAllocated: Scalars['Int']; outOfStockThreshold: Scalars['Int']; useGlobalOutOfStockThreshold: Scalars['Boolean']; stockMovements: StockMovementList; channels: Array; id: Scalars['ID']; product: Product; productId: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; languageCode: LanguageCode; sku: Scalars['String']; name: Scalars['String']; featuredAsset?: Maybe; assets: Array; price: Scalars['Int']; currencyCode: CurrencyCode; priceWithTax: Scalars['Int']; stockLevel: Scalars['String']; taxRateApplied: TaxRate; taxCategory: TaxCategory; options: Array; facetValues: Array; translations: Array; customFields?: Maybe; }; export type ProductVariantStockMovementsArgs = { options?: Maybe; }; export type ProductVariantFilterParameter = { enabled?: Maybe; trackInventory?: Maybe; stockOnHand?: Maybe; stockAllocated?: Maybe; outOfStockThreshold?: Maybe; useGlobalOutOfStockThreshold?: Maybe; id?: Maybe; productId?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; languageCode?: Maybe; sku?: Maybe; name?: Maybe; price?: Maybe; currencyCode?: Maybe; priceWithTax?: Maybe; stockLevel?: Maybe; }; export type ProductVariantList = PaginatedList & { __typename?: 'ProductVariantList'; items: Array; totalItems: Scalars['Int']; }; export type ProductVariantListOptions = { /** Skips the first n results, for use in pagination */ skip?: Maybe; /** Takes n results, for use in pagination */ take?: Maybe; /** Specifies which properties to sort the results by */ sort?: Maybe; /** Allows the results to be filtered */ filter?: Maybe; /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */ filterOperator?: Maybe; }; export type ProductVariantSortParameter = { stockOnHand?: Maybe; stockAllocated?: Maybe; outOfStockThreshold?: Maybe; id?: Maybe; productId?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; sku?: Maybe; name?: Maybe; price?: Maybe; priceWithTax?: Maybe; stockLevel?: Maybe; }; export type ProductVariantTranslation = { __typename?: 'ProductVariantTranslation'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; languageCode: LanguageCode; name: Scalars['String']; }; export type ProductVariantTranslationInput = { id?: Maybe; languageCode: LanguageCode; name?: Maybe; customFields?: Maybe; }; export type Promotion = Node & { __typename?: 'Promotion'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; startsAt?: Maybe; endsAt?: Maybe; couponCode?: Maybe; perCustomerUsageLimit?: Maybe; name: Scalars['String']; enabled: Scalars['Boolean']; conditions: Array; actions: Array; customFields?: Maybe; }; export type PromotionFilterParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; startsAt?: Maybe; endsAt?: Maybe; couponCode?: Maybe; perCustomerUsageLimit?: Maybe; name?: Maybe; enabled?: Maybe; }; export type PromotionList = PaginatedList & { __typename?: 'PromotionList'; items: Array; totalItems: Scalars['Int']; }; export type PromotionListOptions = { /** Skips the first n results, for use in pagination */ skip?: Maybe; /** Takes n results, for use in pagination */ take?: Maybe; /** Specifies which properties to sort the results by */ sort?: Maybe; /** Allows the results to be filtered */ filter?: Maybe; /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */ filterOperator?: Maybe; }; export type PromotionSortParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; startsAt?: Maybe; endsAt?: Maybe; couponCode?: Maybe; perCustomerUsageLimit?: Maybe; name?: Maybe; }; /** Returned if the specified quantity of an OrderLine is greater than the number of items in that line */ export type QuantityTooGreatError = ErrorResult & { __typename?: 'QuantityTooGreatError'; errorCode: ErrorCode; message: Scalars['String']; }; export type Query = { __typename?: 'Query'; administrators: AdministratorList; administrator?: Maybe; activeAdministrator?: Maybe; /** Get a list of Assets */ assets: AssetList; /** Get a single Asset by id */ asset?: Maybe; me?: Maybe; channels: Array; channel?: Maybe; activeChannel: Channel; collections: CollectionList; /** Get a Collection either by id or slug. If neither id nor slug is specified, an error will result. */ collection?: Maybe; collectionFilters: Array; countries: CountryList; country?: Maybe; customerGroups: CustomerGroupList; customerGroup?: Maybe; customers: CustomerList; customer?: Maybe; facets: FacetList; facet?: Maybe; globalSettings: GlobalSettings; job?: Maybe; jobs: JobList; jobsById: Array; jobQueues: Array; jobBufferSize: Array; order?: Maybe; orders: OrderList; paymentMethods: PaymentMethodList; paymentMethod?: Maybe; paymentMethodEligibilityCheckers: Array; paymentMethodHandlers: Array; productOptionGroups: Array; productOptionGroup?: Maybe; search: SearchResponse; pendingSearchIndexUpdates: Scalars['Int']; /** List Products */ products: ProductList; /** Get a Product either by id or slug. If neither id nor slug is specified, an error will result. */ product?: Maybe; /** List ProductVariants either all or for the specific product. */ productVariants: ProductVariantList; /** Get a ProductVariant by id */ productVariant?: Maybe; promotion?: Maybe; promotions: PromotionList; promotionConditions: Array; promotionActions: Array; roles: RoleList; role?: Maybe; shippingMethods: ShippingMethodList; shippingMethod?: Maybe; shippingEligibilityCheckers: Array; shippingCalculators: Array; fulfillmentHandlers: Array; testShippingMethod: TestShippingMethodResult; testEligibleShippingMethods: Array; tag: Tag; tags: TagList; taxCategories: Array; taxCategory?: Maybe; taxRates: TaxRateList; taxRate?: Maybe; zones: Array; zone?: Maybe; }; export type QueryAdministratorsArgs = { options?: Maybe; }; export type QueryAdministratorArgs = { id: Scalars['ID']; }; export type QueryAssetsArgs = { options?: Maybe; }; export type QueryAssetArgs = { id: Scalars['ID']; }; export type QueryChannelArgs = { id: Scalars['ID']; }; export type QueryCollectionsArgs = { options?: Maybe; }; export type QueryCollectionArgs = { id?: Maybe; slug?: Maybe; }; export type QueryCountriesArgs = { options?: Maybe; }; export type QueryCountryArgs = { id: Scalars['ID']; }; export type QueryCustomerGroupsArgs = { options?: Maybe; }; export type QueryCustomerGroupArgs = { id: Scalars['ID']; }; export type QueryCustomersArgs = { options?: Maybe; }; export type QueryCustomerArgs = { id: Scalars['ID']; }; export type QueryFacetsArgs = { options?: Maybe; }; export type QueryFacetArgs = { id: Scalars['ID']; }; export type QueryJobArgs = { jobId: Scalars['ID']; }; export type QueryJobsArgs = { options?: Maybe; }; export type QueryJobsByIdArgs = { jobIds: Array; }; export type QueryJobBufferSizeArgs = { bufferIds?: Maybe>; }; export type QueryOrderArgs = { id: Scalars['ID']; }; export type QueryOrdersArgs = { options?: Maybe; }; export type QueryPaymentMethodsArgs = { options?: Maybe; }; export type QueryPaymentMethodArgs = { id: Scalars['ID']; }; export type QueryProductOptionGroupsArgs = { filterTerm?: Maybe; }; export type QueryProductOptionGroupArgs = { id: Scalars['ID']; }; export type QuerySearchArgs = { input: SearchInput; }; export type QueryProductsArgs = { options?: Maybe; }; export type QueryProductArgs = { id?: Maybe; slug?: Maybe; }; export type QueryProductVariantsArgs = { options?: Maybe; productId?: Maybe; }; export type QueryProductVariantArgs = { id: Scalars['ID']; }; export type QueryPromotionArgs = { id: Scalars['ID']; }; export type QueryPromotionsArgs = { options?: Maybe; }; export type QueryRolesArgs = { options?: Maybe; }; export type QueryRoleArgs = { id: Scalars['ID']; }; export type QueryShippingMethodsArgs = { options?: Maybe; }; export type QueryShippingMethodArgs = { id: Scalars['ID']; }; export type QueryTestShippingMethodArgs = { input: TestShippingMethodInput; }; export type QueryTestEligibleShippingMethodsArgs = { input: TestEligibleShippingMethodsInput; }; export type QueryTagArgs = { id: Scalars['ID']; }; export type QueryTagsArgs = { options?: Maybe; }; export type QueryTaxCategoryArgs = { id: Scalars['ID']; }; export type QueryTaxRatesArgs = { options?: Maybe; }; export type QueryTaxRateArgs = { id: Scalars['ID']; }; export type QueryZoneArgs = { id: Scalars['ID']; }; export type Refund = Node & { __typename?: 'Refund'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; items: Scalars['Int']; shipping: Scalars['Int']; adjustment: Scalars['Int']; total: Scalars['Int']; method?: Maybe; state: Scalars['String']; transactionId?: Maybe; reason?: Maybe; orderItems: Array; paymentId: Scalars['ID']; metadata?: Maybe; }; export type RefundOrderInput = { lines: Array; shipping: Scalars['Int']; adjustment: Scalars['Int']; paymentId: Scalars['ID']; reason?: Maybe; }; export type RefundOrderResult = Refund | QuantityTooGreatError | NothingToRefundError | OrderStateTransitionError | MultipleOrderError | PaymentOrderMismatchError | RefundOrderStateError | AlreadyRefundedError | RefundStateTransitionError; /** Returned if an attempting to refund an Order which is not in the expected state */ export type RefundOrderStateError = ErrorResult & { __typename?: 'RefundOrderStateError'; errorCode: ErrorCode; message: Scalars['String']; orderState: Scalars['String']; }; /** * Returned when a call to modifyOrder fails to include a refundPaymentId even * though the price has decreased as a result of the changes. */ export type RefundPaymentIdMissingError = ErrorResult & { __typename?: 'RefundPaymentIdMissingError'; errorCode: ErrorCode; message: Scalars['String']; }; /** Returned when there is an error in transitioning the Refund state */ export type RefundStateTransitionError = ErrorResult & { __typename?: 'RefundStateTransitionError'; errorCode: ErrorCode; message: Scalars['String']; transitionError: Scalars['String']; fromState: Scalars['String']; toState: Scalars['String']; }; export type RelationCustomFieldConfig = CustomField & { __typename?: 'RelationCustomFieldConfig'; name: Scalars['String']; type: Scalars['String']; list: Scalars['Boolean']; label?: Maybe>; description?: Maybe>; readonly?: Maybe; internal?: Maybe; nullable?: Maybe; entity: Scalars['String']; scalarFields: Array; ui?: Maybe; }; export type Release = Node & StockMovement & { __typename?: 'Release'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; productVariant: ProductVariant; type: StockMovementType; quantity: Scalars['Int']; orderItem: OrderItem; }; export type RemoveOptionGroupFromProductResult = Product | ProductOptionInUseError; export type RemoveProductVariantsFromChannelInput = { productVariantIds: Array; channelId: Scalars['ID']; }; export type RemoveProductsFromChannelInput = { productIds: Array; channelId: Scalars['ID']; }; export type RemovePromotionsFromChannelInput = { promotionIds: Array; channelId: Scalars['ID']; }; export type Return = Node & StockMovement & { __typename?: 'Return'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; productVariant: ProductVariant; type: StockMovementType; quantity: Scalars['Int']; orderItem: OrderItem; }; export type Role = Node & { __typename?: 'Role'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; code: Scalars['String']; description: Scalars['String']; permissions: Array; channels: Array; }; export type RoleFilterParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; code?: Maybe; description?: Maybe; }; export type RoleList = PaginatedList & { __typename?: 'RoleList'; items: Array; totalItems: Scalars['Int']; }; export type RoleListOptions = { /** Skips the first n results, for use in pagination */ skip?: Maybe; /** Takes n results, for use in pagination */ take?: Maybe; /** Specifies which properties to sort the results by */ sort?: Maybe; /** Allows the results to be filtered */ filter?: Maybe; /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */ filterOperator?: Maybe; }; export type RoleSortParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; code?: Maybe; description?: Maybe; }; export type Sale = Node & StockMovement & { __typename?: 'Sale'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; productVariant: ProductVariant; type: StockMovementType; quantity: Scalars['Int']; orderItem: OrderItem; }; export type SearchInput = { term?: Maybe; facetValueIds?: Maybe>; facetValueOperator?: Maybe; facetValueFilters?: Maybe>; collectionId?: Maybe; collectionSlug?: Maybe; groupByProduct?: Maybe; take?: Maybe; skip?: Maybe; sort?: Maybe; }; export type SearchReindexResponse = { __typename?: 'SearchReindexResponse'; success: Scalars['Boolean']; }; export type SearchResponse = { __typename?: 'SearchResponse'; items: Array; totalItems: Scalars['Int']; facetValues: Array; collections: Array; }; export type SearchResult = { __typename?: 'SearchResult'; enabled: Scalars['Boolean']; /** An array of ids of the Channels in which this result appears */ channelIds: Array; sku: Scalars['String']; slug: Scalars['String']; productId: Scalars['ID']; productName: Scalars['String']; productAsset?: Maybe; productVariantId: Scalars['ID']; productVariantName: Scalars['String']; productVariantAsset?: Maybe; price: SearchResultPrice; priceWithTax: SearchResultPrice; currencyCode: CurrencyCode; description: Scalars['String']; facetIds: Array; facetValueIds: Array; /** An array of ids of the Collections in which this result appears */ collectionIds: Array; /** A relevance score for the result. Differs between database implementations */ score: Scalars['Float']; }; export type SearchResultAsset = { __typename?: 'SearchResultAsset'; id: Scalars['ID']; preview: Scalars['String']; focalPoint?: Maybe; }; /** The price of a search result product, either as a range or as a single price */ export type SearchResultPrice = PriceRange | SinglePrice; export type SearchResultSortParameter = { name?: Maybe; price?: Maybe; }; export type ServerConfig = { __typename?: 'ServerConfig'; orderProcess: Array; permittedAssetTypes: Array; permissions: Array; customFieldConfig: CustomFields; }; /** Returned if the Payment settlement fails */ export type SettlePaymentError = ErrorResult & { __typename?: 'SettlePaymentError'; errorCode: ErrorCode; message: Scalars['String']; paymentErrorMessage: Scalars['String']; }; export type SettlePaymentResult = Payment | SettlePaymentError | PaymentStateTransitionError | OrderStateTransitionError; export type SettleRefundInput = { id: Scalars['ID']; transactionId: Scalars['String']; }; export type SettleRefundResult = Refund | RefundStateTransitionError; export type ShippingLine = { __typename?: 'ShippingLine'; shippingMethod: ShippingMethod; price: Scalars['Int']; priceWithTax: Scalars['Int']; discountedPrice: Scalars['Int']; discountedPriceWithTax: Scalars['Int']; discounts: Array; }; export type ShippingMethod = Node & { __typename?: 'ShippingMethod'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; code: Scalars['String']; name: Scalars['String']; description: Scalars['String']; fulfillmentHandlerCode: Scalars['String']; checker: ConfigurableOperation; calculator: ConfigurableOperation; translations: Array; customFields?: Maybe; }; export type ShippingMethodFilterParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; code?: Maybe; name?: Maybe; description?: Maybe; fulfillmentHandlerCode?: Maybe; }; export type ShippingMethodList = PaginatedList & { __typename?: 'ShippingMethodList'; items: Array; totalItems: Scalars['Int']; }; export type ShippingMethodListOptions = { /** Skips the first n results, for use in pagination */ skip?: Maybe; /** Takes n results, for use in pagination */ take?: Maybe; /** Specifies which properties to sort the results by */ sort?: Maybe; /** Allows the results to be filtered */ filter?: Maybe; /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */ filterOperator?: Maybe; }; export type ShippingMethodQuote = { __typename?: 'ShippingMethodQuote'; id: Scalars['ID']; price: Scalars['Int']; priceWithTax: Scalars['Int']; code: Scalars['String']; name: Scalars['String']; description: Scalars['String']; /** Any optional metadata returned by the ShippingCalculator in the ShippingCalculationResult */ metadata?: Maybe; customFields?: Maybe; }; export type ShippingMethodSortParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; code?: Maybe; name?: Maybe; description?: Maybe; fulfillmentHandlerCode?: Maybe; }; export type ShippingMethodTranslation = { __typename?: 'ShippingMethodTranslation'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; languageCode: LanguageCode; name: Scalars['String']; description: Scalars['String']; }; export type ShippingMethodTranslationInput = { id?: Maybe; languageCode: LanguageCode; name?: Maybe; description?: Maybe; customFields?: Maybe; }; /** The price value where the result has a single price */ export type SinglePrice = { __typename?: 'SinglePrice'; value: Scalars['Int']; }; export enum SortOrder { ASC = 'ASC', DESC = 'DESC' } export type StockAdjustment = Node & StockMovement & { __typename?: 'StockAdjustment'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; productVariant: ProductVariant; type: StockMovementType; quantity: Scalars['Int']; }; export type StockMovement = { id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; productVariant: ProductVariant; type: StockMovementType; quantity: Scalars['Int']; }; export type StockMovementItem = StockAdjustment | Allocation | Sale | Cancellation | Return | Release; export type StockMovementList = { __typename?: 'StockMovementList'; items: Array; totalItems: Scalars['Int']; }; export type StockMovementListOptions = { type?: Maybe; skip?: Maybe; take?: Maybe; }; export enum StockMovementType { ADJUSTMENT = 'ADJUSTMENT', ALLOCATION = 'ALLOCATION', RELEASE = 'RELEASE', SALE = 'SALE', CANCELLATION = 'CANCELLATION', RETURN = 'RETURN' } export type StringCustomFieldConfig = CustomField & { __typename?: 'StringCustomFieldConfig'; name: Scalars['String']; type: Scalars['String']; list: Scalars['Boolean']; length?: Maybe; label?: Maybe>; description?: Maybe>; readonly?: Maybe; internal?: Maybe; nullable?: Maybe; pattern?: Maybe; options?: Maybe>; ui?: Maybe; }; export type StringFieldOption = { __typename?: 'StringFieldOption'; value: Scalars['String']; label?: Maybe>; }; /** Operators for filtering on a String field */ export type StringOperators = { eq?: Maybe; notEq?: Maybe; contains?: Maybe; notContains?: Maybe; in?: Maybe>; notIn?: Maybe>; regex?: Maybe; }; /** Indicates that an operation succeeded, where we do not want to return any more specific information. */ export type Success = { __typename?: 'Success'; success: Scalars['Boolean']; }; export type Surcharge = Node & { __typename?: 'Surcharge'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; description: Scalars['String']; sku?: Maybe; taxLines: Array; price: Scalars['Int']; priceWithTax: Scalars['Int']; taxRate: Scalars['Float']; }; export type SurchargeInput = { description: Scalars['String']; sku?: Maybe; price: Scalars['Int']; priceIncludesTax: Scalars['Boolean']; taxRate?: Maybe; taxDescription?: Maybe; }; export type Tag = Node & { __typename?: 'Tag'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; value: Scalars['String']; }; export type TagFilterParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; value?: Maybe; }; export type TagList = PaginatedList & { __typename?: 'TagList'; items: Array; totalItems: Scalars['Int']; }; export type TagListOptions = { /** Skips the first n results, for use in pagination */ skip?: Maybe; /** Takes n results, for use in pagination */ take?: Maybe; /** Specifies which properties to sort the results by */ sort?: Maybe; /** Allows the results to be filtered */ filter?: Maybe; /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */ filterOperator?: Maybe; }; export type TagSortParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; value?: Maybe; }; export type TaxCategory = Node & { __typename?: 'TaxCategory'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; name: Scalars['String']; isDefault: Scalars['Boolean']; customFields?: Maybe; }; export type TaxLine = { __typename?: 'TaxLine'; description: Scalars['String']; taxRate: Scalars['Float']; }; export type TaxRate = Node & { __typename?: 'TaxRate'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; name: Scalars['String']; enabled: Scalars['Boolean']; value: Scalars['Float']; category: TaxCategory; zone: Zone; customerGroup?: Maybe; customFields?: Maybe; }; export type TaxRateFilterParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; name?: Maybe; enabled?: Maybe; value?: Maybe; }; export type TaxRateList = PaginatedList & { __typename?: 'TaxRateList'; items: Array; totalItems: Scalars['Int']; }; export type TaxRateListOptions = { /** Skips the first n results, for use in pagination */ skip?: Maybe; /** Takes n results, for use in pagination */ take?: Maybe; /** Specifies which properties to sort the results by */ sort?: Maybe; /** Allows the results to be filtered */ filter?: Maybe; /** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */ filterOperator?: Maybe; }; export type TaxRateSortParameter = { id?: Maybe; createdAt?: Maybe; updatedAt?: Maybe; name?: Maybe; value?: Maybe; }; export type TestEligibleShippingMethodsInput = { shippingAddress: CreateAddressInput; lines: Array; }; export type TestShippingMethodInput = { checker: ConfigurableOperationInput; calculator: ConfigurableOperationInput; shippingAddress: CreateAddressInput; lines: Array; }; export type TestShippingMethodOrderLineInput = { productVariantId: Scalars['ID']; quantity: Scalars['Int']; }; export type TestShippingMethodQuote = { __typename?: 'TestShippingMethodQuote'; price: Scalars['Int']; priceWithTax: Scalars['Int']; metadata?: Maybe; }; export type TestShippingMethodResult = { __typename?: 'TestShippingMethodResult'; eligible: Scalars['Boolean']; quote?: Maybe; }; export type TextCustomFieldConfig = CustomField & { __typename?: 'TextCustomFieldConfig'; name: Scalars['String']; type: Scalars['String']; list: Scalars['Boolean']; label?: Maybe>; description?: Maybe>; readonly?: Maybe; internal?: Maybe; nullable?: Maybe; ui?: Maybe; }; export type TransitionFulfillmentToStateResult = Fulfillment | FulfillmentStateTransitionError; export type TransitionOrderToStateResult = Order | OrderStateTransitionError; export type TransitionPaymentToStateResult = Payment | PaymentStateTransitionError; export type UpdateActiveAdministratorInput = { firstName?: Maybe; lastName?: Maybe; emailAddress?: Maybe; password?: Maybe; customFields?: Maybe; }; export type UpdateAddressInput = { id: Scalars['ID']; fullName?: Maybe; company?: Maybe; streetLine1?: Maybe; streetLine2?: Maybe; city?: Maybe; province?: Maybe; postalCode?: Maybe; countryCode?: Maybe; phoneNumber?: Maybe; defaultShippingAddress?: Maybe; defaultBillingAddress?: Maybe; customFields?: Maybe; }; export type UpdateAdministratorInput = { id: Scalars['ID']; firstName?: Maybe; lastName?: Maybe; emailAddress?: Maybe; password?: Maybe; roleIds?: Maybe>; customFields?: Maybe; }; export type UpdateAssetInput = { id: Scalars['ID']; name?: Maybe; focalPoint?: Maybe; tags?: Maybe>; customFields?: Maybe; }; export type UpdateChannelInput = { id: Scalars['ID']; code?: Maybe; token?: Maybe; defaultLanguageCode?: Maybe; pricesIncludeTax?: Maybe; currencyCode?: Maybe; defaultTaxZoneId?: Maybe; defaultShippingZoneId?: Maybe; customFields?: Maybe; }; export type UpdateChannelResult = Channel | LanguageNotAvailableError; export type UpdateCollectionInput = { id: Scalars['ID']; isPrivate?: Maybe; featuredAssetId?: Maybe; parentId?: Maybe; assetIds?: Maybe>; filters?: Maybe>; translations?: Maybe>; customFields?: Maybe; }; export type UpdateCollectionTranslationInput = { id?: Maybe; languageCode: LanguageCode; name?: Maybe; slug?: Maybe; description?: Maybe; customFields?: Maybe; }; export type UpdateCountryInput = { id: Scalars['ID']; code?: Maybe; translations?: Maybe>; enabled?: Maybe; customFields?: Maybe; }; export type UpdateCustomerGroupInput = { id: Scalars['ID']; name?: Maybe; customFields?: Maybe; }; export type UpdateCustomerInput = { id: Scalars['ID']; title?: Maybe; firstName?: Maybe; lastName?: Maybe; phoneNumber?: Maybe; emailAddress?: Maybe; customFields?: Maybe; }; export type UpdateCustomerNoteInput = { noteId: Scalars['ID']; note: Scalars['String']; }; export type UpdateCustomerResult = Customer | EmailAddressConflictError; export type UpdateFacetInput = { id: Scalars['ID']; isPrivate?: Maybe; code?: Maybe; translations?: Maybe>; customFields?: Maybe; }; export type UpdateFacetValueInput = { id: Scalars['ID']; code?: Maybe; translations?: Maybe>; customFields?: Maybe; }; export type UpdateGlobalSettingsInput = { availableLanguages?: Maybe>; trackInventory?: Maybe; outOfStockThreshold?: Maybe; customFields?: Maybe; }; export type UpdateGlobalSettingsResult = GlobalSettings | ChannelDefaultLanguageError; export type UpdateOrderAddressInput = { fullName?: Maybe; company?: Maybe; streetLine1?: Maybe; streetLine2?: Maybe; city?: Maybe; province?: Maybe; postalCode?: Maybe; countryCode?: Maybe; phoneNumber?: Maybe; }; export type UpdateOrderInput = { id: Scalars['ID']; customFields?: Maybe; }; export type UpdateOrderNoteInput = { noteId: Scalars['ID']; note?: Maybe; isPublic?: Maybe; }; export type UpdatePaymentMethodInput = { id: Scalars['ID']; name?: Maybe; code?: Maybe; description?: Maybe; enabled?: Maybe; checker?: Maybe; handler?: Maybe; customFields?: Maybe; }; export type UpdateProductInput = { id: Scalars['ID']; enabled?: Maybe; featuredAssetId?: Maybe; assetIds?: Maybe>; facetValueIds?: Maybe>; translations?: Maybe>; customFields?: Maybe; }; export type UpdateProductOptionGroupInput = { id: Scalars['ID']; code?: Maybe; translations?: Maybe>; customFields?: Maybe; }; export type UpdateProductOptionInput = { id: Scalars['ID']; code?: Maybe; translations?: Maybe>; customFields?: Maybe; }; export type UpdateProductVariantInput = { id: Scalars['ID']; enabled?: Maybe; translations?: Maybe>; facetValueIds?: Maybe>; sku?: Maybe; taxCategoryId?: Maybe; price?: Maybe; featuredAssetId?: Maybe; assetIds?: Maybe>; stockOnHand?: Maybe; outOfStockThreshold?: Maybe; useGlobalOutOfStockThreshold?: Maybe; trackInventory?: Maybe; customFields?: Maybe; }; export type UpdatePromotionInput = { id: Scalars['ID']; name?: Maybe; enabled?: Maybe; startsAt?: Maybe; endsAt?: Maybe; couponCode?: Maybe; perCustomerUsageLimit?: Maybe; conditions?: Maybe>; actions?: Maybe>; customFields?: Maybe; }; export type UpdatePromotionResult = Promotion | MissingConditionsError; export type UpdateRoleInput = { id: Scalars['ID']; code?: Maybe; description?: Maybe; permissions?: Maybe>; channelIds?: Maybe>; }; export type UpdateShippingMethodInput = { id: Scalars['ID']; code?: Maybe; fulfillmentHandler?: Maybe; checker?: Maybe; calculator?: Maybe; translations: Array; customFields?: Maybe; }; export type UpdateTagInput = { id: Scalars['ID']; value?: Maybe; }; export type UpdateTaxCategoryInput = { id: Scalars['ID']; name?: Maybe; isDefault?: Maybe; customFields?: Maybe; }; export type UpdateTaxRateInput = { id: Scalars['ID']; name?: Maybe; value?: Maybe; enabled?: Maybe; categoryId?: Maybe; zoneId?: Maybe; customerGroupId?: Maybe; customFields?: Maybe; }; export type UpdateZoneInput = { id: Scalars['ID']; name?: Maybe; customFields?: Maybe; }; export type User = Node & { __typename?: 'User'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; identifier: Scalars['String']; verified: Scalars['Boolean']; roles: Array; lastLogin?: Maybe; authenticationMethods: Array; customFields?: Maybe; }; export type Zone = Node & { __typename?: 'Zone'; id: Scalars['ID']; createdAt: Scalars['DateTime']; updatedAt: Scalars['DateTime']; name: Scalars['String']; members: Array; customFields?: Maybe; };