diff --git a/codegen.bigcommerce.json b/codegen.bigcommerce.json new file mode 100644 index 000000000..1f14e88ac --- /dev/null +++ b/codegen.bigcommerce.json @@ -0,0 +1,27 @@ +{ + "schema": { + "https://buybutton.store/graphql": { + "headers": { + "Authorization": "Bearer xzy" + } + } + }, + "documents": [ + { + "./framework/bigcommerce/api/**/*.ts": { + "noRequire": true + } + } + ], + "generates": { + "./framework/bigcommerce/schema.d.ts": { + "plugins": ["typescript", "typescript-operations"] + }, + "./framework/bigcommerce/schema.graphql": { + "plugins": ["schema-ast"] + } + }, + "hooks": { + "afterAllFileWrite": ["prettier --write"] + } +} diff --git a/codegen.json b/codegen.json index 1f14e88ac..d9a5c09ce 100644 --- a/codegen.json +++ b/codegen.json @@ -1,23 +1,29 @@ { "schema": { - "https://buybutton.store/graphql": { - "headers": { - "Authorization": "Bearer xzy" - } - } + "https://master.staging.saleor.cloud/graphql/": {} }, "documents": [ { - "./framework/bigcommerce/api/**/*.ts": { + "./framework/saleor/utils/queries/get-all-products-query.ts": { + "noRequire": true + } + }, + { + "./framework/saleor/utils/queries/get-all-products-paths-query.ts": { + "noRequire": true + } + }, + { + "./framework/saleor/utils/queries/get-products.ts": { "noRequire": true } } ], "generates": { - "./framework/bigcommerce/schema.d.ts": { + "./framework/saleor/schema.d.ts": { "plugins": ["typescript", "typescript-operations"] }, - "./framework/bigcommerce/schema.graphql": { + "./framework/saleor/schema.graphql": { "plugins": ["schema-ast"] } }, diff --git a/commerce.config.json b/commerce.config.json index a0e7afc5d..06b985504 100644 --- a/commerce.config.json +++ b/commerce.config.json @@ -1,5 +1,6 @@ { "features": { - "wishlist": true + "wishlist": false, + "customCheckout": false } } diff --git a/framework/saleor/common/get-all-pages.ts b/framework/saleor/common/get-all-pages.ts index 5440f3651..27993b552 100644 --- a/framework/saleor/common/get-all-pages.ts +++ b/framework/saleor/common/get-all-pages.ts @@ -23,7 +23,7 @@ const getAllPages = async (options?: { config: SaleorConfig preview?: boolean }): Promise => { - let { config, variables = { first: 250 } } = options ?? {} + let { config, variables = { first: 100 } } = options ?? {} config = getConfig(config) const { locale } = config const { data } = await config.fetch(getAllPagesQuery, { variables }) diff --git a/framework/saleor/product/get-all-collections.ts b/framework/saleor/product/get-all-collections.ts index a7ec27bf7..0356ea6ec 100644 --- a/framework/saleor/product/get-all-collections.ts +++ b/framework/saleor/product/get-all-collections.ts @@ -7,17 +7,17 @@ const getAllCollections = async (options?: { config: SaleorConfig preview?: boolean }) => { - let { config, variables = { first: 250 } } = options ?? {} + let { config, variables = { first: 100 } } = options ?? {} config = getConfig(config) const { data } = await config.fetch(getAllCollectionsQuery, { variables }) const edges = data.collections?.edges ?? [] const categories = edges.map( - ({ node: { id: entityId, title: name, handle } }: CollectionEdge) => ({ + ({ node: { id: entityId, name, slug } }: CollectionEdge) => ({ entityId, name, - path: `/${handle}`, + path: `/${slug}`, }) ) diff --git a/framework/saleor/product/get-all-product-paths.ts b/framework/saleor/product/get-all-product-paths.ts index 00b425f9b..ea4867092 100644 --- a/framework/saleor/product/get-all-product-paths.ts +++ b/framework/saleor/product/get-all-product-paths.ts @@ -21,7 +21,7 @@ const getAllProductPaths = async (options?: { config?: SaleorConfig preview?: boolean }): Promise => { - let { config, variables = { first: 250 } } = options ?? {} + let { config, variables = { first: 100 } } = options ?? {} config = getConfig(config) const products = await fetchAllProducts({ diff --git a/framework/saleor/product/get-all-products.ts b/framework/saleor/product/get-all-products.ts index 15f3d98a3..0acb3b8da 100644 --- a/framework/saleor/product/get-all-products.ts +++ b/framework/saleor/product/get-all-products.ts @@ -1,6 +1,6 @@ import { GraphQLFetcherResult } from '@commerce/api' import { getConfig, SaleorConfig } from '../api' -import { ProductEdge } from '../schema' +import { Product as SaleorProduct } from '../schema' import { getAllProductsQuery } from '../utils/queries' import { normalizeProduct } from '../utils/normalize' import { Product } from '@commerce/types' @@ -19,7 +19,7 @@ const getAllProducts = async (options: { config?: SaleorConfig preview?: boolean }): Promise => { - let { config, variables = { first: 250 } } = options ?? {} + let { config, variables = { first: 100 } } = options ?? {} config = getConfig(config) const { data }: GraphQLFetcherResult = await config.fetch( @@ -28,7 +28,7 @@ const getAllProducts = async (options: { ) const products = - data.products?.edges?.map(({ node: p }: ProductEdge) => + data.products?.edges?.map(({ node: p }: SaleorProduct) => normalizeProduct(p) ) ?? [] diff --git a/framework/saleor/product/get-product.ts b/framework/saleor/product/get-product.ts index d94a3f09d..139aca908 100644 --- a/framework/saleor/product/get-product.ts +++ b/framework/saleor/product/get-product.ts @@ -22,7 +22,7 @@ const getProduct = async (options: { variables, }) - const { productByHandle: product } = data + const { product } = data return { product: product ? normalizeProduct(product) : null, diff --git a/framework/saleor/schema.d.ts b/framework/saleor/schema.d.ts index b1b23a3e5..0acff9c65 100644 --- a/framework/saleor/schema.d.ts +++ b/framework/saleor/schema.d.ts @@ -13,4973 +13,12156 @@ export type Scalars = { Boolean: boolean Int: number Float: number - /** An ISO-8601 encoded UTC date time string. Example value: `"2019-07-03T20:47:55Z"`. */ + /** + * The `DateTime` scalar type represents a DateTime + * value as specified by + * [iso8601](https://en.wikipedia.org/wiki/ISO_8601). + */ DateTime: any - /** A signed decimal number, which supports arbitrary precision and is serialized as a string. Example value: `"29.99"`. */ - Decimal: any - /** A string containing HTML code. Example value: `"

Grey cotton knit sweater.

"`. */ - HTML: any - /** A monetary value string. Example value: `"100.57"`. */ - Money: any /** - * An RFC 3986 and RFC 3987 compliant URI string. + * Allows use of a JSON String for input / output from the GraphQL schema. * - * Example value: `"https://johns-apparel.myshopify.com"`. + * Use of this type is *not recommended* as you lose the benefits of having a defined, static + * schema (one of the key benefits of GraphQL). + */ + JSONString: any + UUID: any + /** + * The `Date` scalar type represents a Date + * value as specified by + * [iso8601](https://en.wikipedia.org/wiki/ISO_8601). + */ + Date: any + /** + * Positive Decimal scalar implementation. * + * Should be used in places where value must be positive. */ - URL: any + PositiveDecimal: any + /** Anything */ + _Any: any + WeightScalar: any + /** Variables of this type must be set to null in mutations. They will be replaced with a filename from a following multipart part containing a binary file. See: https://github.com/jaydenseric/graphql-multipart-request-spec. */ + Upload: any + /** + * The `GenericScalar` scalar type represents a generic + * GraphQL scalar value that could be: + * String, Boolean, Int, Float, List or Object. + */ + GenericScalar: any } -/** A version of the API. */ -export type ApiVersion = { - __typename?: 'ApiVersion' - /** The human-readable name of the version. */ - displayName: Scalars['String'] - /** The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle. */ - handle: Scalars['String'] - /** Whether the version is supported by Shopify. */ - supported: Scalars['Boolean'] +export type Query = { + __typename?: 'Query' + /** Look up a webhook by ID. */ + webhook?: Maybe + /** List of all available webhook events. */ + webhookEvents?: Maybe>> + /** Retrieve a sample payload for a given webhook event based on real data. It can be useful for some integrations where sample payload is required. */ + webhookSamplePayload?: Maybe + /** Look up a warehouse by ID. */ + warehouse?: Maybe + /** List of warehouses. */ + warehouses?: Maybe + /** Returns a list of all translatable items of a given kind. */ + translations?: Maybe + translation?: Maybe + /** Look up a stock by ID */ + stock?: Maybe + /** List of stocks. */ + stocks?: Maybe + /** Return information about the shop. */ + shop: Shop + /** Order related settings from site settings. */ + orderSettings?: Maybe + /** Look up a shipping zone by ID. */ + shippingZone?: Maybe + /** List of the shop's shipping zones. */ + shippingZones?: Maybe + /** Look up digital content by ID. */ + digitalContent?: Maybe + /** List of digital content. */ + digitalContents?: Maybe + /** List of the shop's categories. */ + categories?: Maybe + /** Look up a category by ID or slug. */ + category?: Maybe + /** Look up a collection by ID. */ + collection?: Maybe + /** List of the shop's collections. */ + collections?: Maybe + /** Look up a product by ID. */ + product?: Maybe + /** List of the shop's products. */ + products?: Maybe + /** Look up a product type by ID. */ + productType?: Maybe + /** List of the shop's product types. */ + productTypes?: Maybe + /** Look up a product variant by ID or SKU. */ + productVariant?: Maybe + /** List of product variants. */ + productVariants?: Maybe + /** List of top selling products. */ + reportProductSales?: Maybe + /** Look up a payment by ID. */ + payment?: Maybe + /** List of payments. */ + payments?: Maybe + /** Look up a page by ID or slug. */ + page?: Maybe + /** List of the shop's pages. */ + pages?: Maybe + /** Look up a page type by ID. */ + pageType?: Maybe + /** List of the page types. */ + pageTypes?: Maybe + /** List of activity events to display on homepage (at the moment it only contains order-events). */ + homepageEvents?: Maybe + /** Look up an order by ID. */ + order?: Maybe + /** List of orders. */ + orders?: Maybe + /** List of draft orders. */ + draftOrders?: Maybe + /** Return the total sales amount from a specific period. */ + ordersTotal?: Maybe + /** Look up an order by token. */ + orderByToken?: Maybe + /** Look up a navigation menu by ID or name. */ + menu?: Maybe + /** List of the storefront's menus. */ + menus?: Maybe + /** Look up a menu item by ID. */ + menuItem?: Maybe + /** List of the storefronts's menu items. */ + menuItems?: Maybe + /** Look up a gift card by ID. */ + giftCard?: Maybe + /** List of gift cards. */ + giftCards?: Maybe + /** Look up a plugin by ID. */ + plugin?: Maybe + /** List of plugins. */ + plugins?: Maybe + /** Look up a sale by ID. */ + sale?: Maybe + /** List of the shop's sales. */ + sales?: Maybe + /** Look up a voucher by ID. */ + voucher?: Maybe + /** List of the shop's vouchers. */ + vouchers?: Maybe + /** Look up a export file by ID. */ + exportFile?: Maybe + /** List of export files. */ + exportFiles?: Maybe + /** List of all tax rates available from tax gateway. */ + taxTypes?: Maybe>> + /** Look up a checkout by token and slug of channel. */ + checkout?: Maybe + /** List of checkouts. */ + checkouts?: Maybe + /** Look up a checkout line by ID. */ + checkoutLine?: Maybe + /** List of checkout lines. */ + checkoutLines?: Maybe + /** Look up a channel by ID. */ + channel?: Maybe + /** List of all channels. */ + channels?: Maybe> + /** List of the shop's attributes. */ + attributes?: Maybe + /** Look up an attribute by ID. */ + attribute?: Maybe + /** List of all apps installations */ + appsInstallations: Array + /** List of the apps. */ + apps?: Maybe + /** Look up an app by ID. If ID is not provided, return the currently authenticated app. */ + app?: Maybe + /** Returns address validation rules. */ + addressValidationRules?: Maybe + /** Look up an address by ID. */ + address?: Maybe
+ /** List of the shop's customers. */ + customers?: Maybe + /** List of permission groups. */ + permissionGroups?: Maybe + /** Look up permission group by ID. */ + permissionGroup?: Maybe + /** Return the currently authenticated user. */ + me?: Maybe + /** List of the shop's staff users. */ + staffUsers?: Maybe + /** Look up a user by ID or email address. */ + user?: Maybe + _entities?: Maybe>> + _service?: Maybe<_Service> } -/** Details about the gift card used on the checkout. */ -export type AppliedGiftCard = Node & { - __typename?: 'AppliedGiftCard' - /** - * The amount that was taken from the gift card by applying it. - * @deprecated Use `amountUsedV2` instead - */ - amountUsed: Scalars['Money'] - /** The amount that was taken from the gift card by applying it. */ - amountUsedV2: MoneyV2 - /** - * The amount left on the gift card. - * @deprecated Use `balanceV2` instead - */ - balance: Scalars['Money'] - /** The amount left on the gift card. */ - balanceV2: MoneyV2 - /** Globally unique identifier. */ +export type QueryWebhookArgs = { id: Scalars['ID'] - /** The last characters of the gift card. */ - lastCharacters: Scalars['String'] - /** The amount that was applied to the checkout in its currency. */ - presentmentAmountUsed: MoneyV2 } -/** An article in an online store blog. */ -export type Article = Node & { - __typename?: 'Article' - /** - * The article's author. - * @deprecated Use `authorV2` instead - */ - author: ArticleAuthor - /** The article's author. */ - authorV2?: Maybe - /** The blog that the article belongs to. */ - blog: Blog - /** List of comments posted on the article. */ - comments: CommentConnection - /** Stripped content of the article, single line with HTML tags removed. */ - content: Scalars['String'] - /** The content of the article, complete with HTML formatting. */ - contentHtml: Scalars['HTML'] - /** Stripped excerpt of the article, single line with HTML tags removed. */ - excerpt?: Maybe - /** The excerpt of the article, complete with HTML formatting. */ - excerptHtml?: Maybe - /** A human-friendly unique string for the Article automatically generated from its title. */ - handle: Scalars['String'] - /** Globally unique identifier. */ +export type QueryWebhookSamplePayloadArgs = { + eventType: WebhookSampleEventTypeEnum +} + +export type QueryWarehouseArgs = { id: Scalars['ID'] - /** The image associated with the article. */ - image?: Maybe - /** The date and time when the article was published. */ - publishedAt: Scalars['DateTime'] - /** The article’s SEO information. */ - seo?: Maybe - /** A categorization that a article can be tagged with. */ - tags: Array - /** The article’s name. */ - title: Scalars['String'] - /** The url pointing to the article accessible from the web. */ - url: Scalars['URL'] } -/** An article in an online store blog. */ -export type ArticleCommentsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe +export type QueryWarehousesArgs = { + filter?: Maybe + sortBy?: Maybe before?: Maybe - reverse?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe } -/** An article in an online store blog. */ -export type ArticleContentArgs = { - truncateAt?: Maybe +export type QueryTranslationsArgs = { + kind: TranslatableKinds + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe } -/** An article in an online store blog. */ -export type ArticleExcerptArgs = { - truncateAt?: Maybe +export type QueryTranslationArgs = { + id: Scalars['ID'] + kind: TranslatableKinds } -/** An article in an online store blog. */ -export type ArticleImageArgs = { - maxWidth?: Maybe - maxHeight?: Maybe - crop?: Maybe - scale?: Maybe +export type QueryStockArgs = { + id: Scalars['ID'] } -/** The author of an article. */ -export type ArticleAuthor = { - __typename?: 'ArticleAuthor' - /** The author's bio. */ - bio?: Maybe - /** The author’s email. */ - email: Scalars['String'] - /** The author's first name. */ - firstName: Scalars['String'] - /** The author's last name. */ - lastName: Scalars['String'] - /** The author's full name. */ +export type QueryStocksArgs = { + filter?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryShippingZoneArgs = { + id: Scalars['ID'] + channel?: Maybe +} + +export type QueryShippingZonesArgs = { + filter?: Maybe + channel?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryDigitalContentArgs = { + id: Scalars['ID'] +} + +export type QueryDigitalContentsArgs = { + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryCategoriesArgs = { + filter?: Maybe + sortBy?: Maybe + level?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryCategoryArgs = { + id?: Maybe + slug?: Maybe +} + +export type QueryCollectionArgs = { + id?: Maybe + slug?: Maybe + channel?: Maybe +} + +export type QueryCollectionsArgs = { + filter?: Maybe + sortBy?: Maybe + channel?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryProductArgs = { + id?: Maybe + slug?: Maybe + channel?: Maybe +} + +export type QueryProductsArgs = { + filter?: Maybe + sortBy?: Maybe + stockAvailability?: Maybe + channel?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryProductTypeArgs = { + id: Scalars['ID'] +} + +export type QueryProductTypesArgs = { + filter?: Maybe + sortBy?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryProductVariantArgs = { + id?: Maybe + sku?: Maybe + channel?: Maybe +} + +export type QueryProductVariantsArgs = { + ids?: Maybe>> + channel?: Maybe + filter?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryReportProductSalesArgs = { + period: ReportingPeriod + channel: Scalars['String'] + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryPaymentArgs = { + id: Scalars['ID'] +} + +export type QueryPaymentsArgs = { + filter?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryPageArgs = { + id?: Maybe + slug?: Maybe +} + +export type QueryPagesArgs = { + sortBy?: Maybe + filter?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryPageTypeArgs = { + id: Scalars['ID'] +} + +export type QueryPageTypesArgs = { + sortBy?: Maybe + filter?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryHomepageEventsArgs = { + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryOrderArgs = { + id: Scalars['ID'] +} + +export type QueryOrdersArgs = { + sortBy?: Maybe + filter?: Maybe + created?: Maybe + status?: Maybe + channel?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryDraftOrdersArgs = { + sortBy?: Maybe + filter?: Maybe + created?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryOrdersTotalArgs = { + period?: Maybe + channel?: Maybe +} + +export type QueryOrderByTokenArgs = { + token: Scalars['UUID'] +} + +export type QueryMenuArgs = { + channel?: Maybe + id?: Maybe + name?: Maybe + slug?: Maybe +} + +export type QueryMenusArgs = { + channel?: Maybe + sortBy?: Maybe + filter?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryMenuItemArgs = { + id: Scalars['ID'] + channel?: Maybe +} + +export type QueryMenuItemsArgs = { + channel?: Maybe + sortBy?: Maybe + filter?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryGiftCardArgs = { + id: Scalars['ID'] +} + +export type QueryGiftCardsArgs = { + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryPluginArgs = { + id: Scalars['ID'] +} + +export type QueryPluginsArgs = { + filter?: Maybe + sortBy?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QuerySaleArgs = { + id: Scalars['ID'] + channel?: Maybe +} + +export type QuerySalesArgs = { + filter?: Maybe + sortBy?: Maybe + query?: Maybe + channel?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryVoucherArgs = { + id: Scalars['ID'] + channel?: Maybe +} + +export type QueryVouchersArgs = { + filter?: Maybe + sortBy?: Maybe + query?: Maybe + channel?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryExportFileArgs = { + id: Scalars['ID'] +} + +export type QueryExportFilesArgs = { + filter?: Maybe + sortBy?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryCheckoutArgs = { + token?: Maybe +} + +export type QueryCheckoutsArgs = { + channel?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryCheckoutLineArgs = { + id?: Maybe +} + +export type QueryCheckoutLinesArgs = { + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryChannelArgs = { + id?: Maybe +} + +export type QueryAttributesArgs = { + filter?: Maybe + sortBy?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryAttributeArgs = { + id?: Maybe + slug?: Maybe +} + +export type QueryAppsArgs = { + filter?: Maybe + sortBy?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryAppArgs = { + id?: Maybe +} + +export type QueryAddressValidationRulesArgs = { + countryCode: CountryCode + countryArea?: Maybe + city?: Maybe + cityArea?: Maybe +} + +export type QueryAddressArgs = { + id: Scalars['ID'] +} + +export type QueryCustomersArgs = { + filter?: Maybe + sortBy?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryPermissionGroupsArgs = { + filter?: Maybe + sortBy?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryPermissionGroupArgs = { + id: Scalars['ID'] +} + +export type QueryStaffUsersArgs = { + filter?: Maybe + sortBy?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type QueryUserArgs = { + id?: Maybe + email?: Maybe +} + +export type Query_EntitiesArgs = { + representations?: Maybe>> +} + +/** Webhook. */ +export type Webhook = Node & { + __typename?: 'Webhook' + name: Scalars['String'] + targetUrl: Scalars['String'] + isActive: Scalars['Boolean'] + secretKey?: Maybe + /** The ID of the object. */ + id: Scalars['ID'] + /** List of webhook events. */ + events: Array + app: App +} + +/** An object with an ID */ +export type Node = { + /** The ID of the object. */ + id: Scalars['ID'] +} + +/** Webhook event. */ +export type WebhookEvent = { + __typename?: 'WebhookEvent' + /** Internal name of the event type. */ + eventType: WebhookEventTypeEnum + /** Display name of the event. */ name: Scalars['String'] } -/** An auto-generated type for paginating through multiple Articles. */ -export type ArticleConnection = { - __typename?: 'ArticleConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo +/** Enum determining type of webhook. */ +export enum WebhookEventTypeEnum { + /** All the events. */ + AnyEvents = 'ANY_EVENTS', + /** A new order is placed. */ + OrderCreated = 'ORDER_CREATED', + /** An order is confirmed (status change unconfirmed -> unfulfilled) by staff user using OrderConfirm mutation. Also triggers when user finish checkout and shop setting `automatically_confirm_all_new_orders` is enabled. */ + OrderConfirmed = 'ORDER_CONFIRMED', + /** Payment is made and an order is fully paid. */ + OrderFullyPaid = 'ORDER_FULLY_PAID', + /** An order is updated; triggered for all changes related to an order; covers all other order webhooks, except for ORDER_CREATED. */ + OrderUpdated = 'ORDER_UPDATED', + /** An order is cancelled. */ + OrderCancelled = 'ORDER_CANCELLED', + /** An order is fulfilled. */ + OrderFulfilled = 'ORDER_FULFILLED', + /** An invoice for order requested. */ + InvoiceRequested = 'INVOICE_REQUESTED', + /** An invoice is deleted. */ + InvoiceDeleted = 'INVOICE_DELETED', + /** Invoice has been sent. */ + InvoiceSent = 'INVOICE_SENT', + /** A new customer account is created. */ + CustomerCreated = 'CUSTOMER_CREATED', + /** A customer account is updated. */ + CustomerUpdated = 'CUSTOMER_UPDATED', + /** A new product is created. */ + ProductCreated = 'PRODUCT_CREATED', + /** A product is updated. */ + ProductUpdated = 'PRODUCT_UPDATED', + /** A product is deleted. */ + ProductDeleted = 'PRODUCT_DELETED', + /** A new product variant is created. */ + ProductVariantCreated = 'PRODUCT_VARIANT_CREATED', + /** A product variant is updated. */ + ProductVariantUpdated = 'PRODUCT_VARIANT_UPDATED', + /** A product variant is deleted. */ + ProductVariantDeleted = 'PRODUCT_VARIANT_DELETED', + /** A new checkout is created. */ + CheckoutCreated = 'CHECKOUT_CREATED', + /** A checkout is updated. Also triggers for all updates related to a checkout. */ + CheckoutUpdated = 'CHECKOUT_UPDATED', + /** A new fulfillment is created. */ + FulfillmentCreated = 'FULFILLMENT_CREATED', + /** User notification triggered. */ + NotifyUser = 'NOTIFY_USER', + /** A new page is created. */ + PageCreated = 'PAGE_CREATED', + /** A page is updated. */ + PageUpdated = 'PAGE_UPDATED', + /** A page is deleted. */ + PageDeleted = 'PAGE_DELETED', } -/** An auto-generated type which holds one Article and a cursor during pagination. */ -export type ArticleEdge = { - __typename?: 'ArticleEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of ArticleEdge. */ - node: Article +/** Represents app data. */ +export type App = Node & + ObjectWithMetadata & { + __typename?: 'App' + /** The ID of the object. */ + id: Scalars['ID'] + /** Name of the app. */ + name?: Maybe + /** The date and time when the app was created. */ + created?: Maybe + /** Determine if app will be set active or not. */ + isActive?: Maybe + /** List of the app's permissions. */ + permissions?: Maybe>> + /** Last 4 characters of the tokens. */ + tokens?: Maybe>> + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + /** Type of the app. */ + type?: Maybe + /** List of webhooks assigned to this app. */ + webhooks?: Maybe>> + /** Description of this app. */ + aboutApp?: Maybe + /** Description of the data privacy defined for this app. */ + dataPrivacy?: Maybe + /** Url to details about the privacy policy on the app owner page. */ + dataPrivacyUrl?: Maybe + /** Homepage of the app. */ + homepageUrl?: Maybe + /** Support page for the app. */ + supportUrl?: Maybe + /** Url to iframe with the configuration for the app. */ + configurationUrl?: Maybe + /** Url to iframe with the app. */ + appUrl?: Maybe + /** Version number of the app. */ + version?: Maybe + /** JWT token used to authenticate by thridparty app. */ + accessToken?: Maybe + } + +export type ObjectWithMetadata = { + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> } -/** The set of valid sort keys for the Article query. */ -export enum ArticleSortKeys { - /** Sort by the `title` value. */ - Title = 'TITLE', - /** Sort by the `blog_title` value. */ - BlogTitle = 'BLOG_TITLE', - /** Sort by the `author` value. */ - Author = 'AUTHOR', - /** Sort by the `updated_at` value. */ - UpdatedAt = 'UPDATED_AT', - /** Sort by the `published_at` value. */ - PublishedAt = 'PUBLISHED_AT', - /** Sort by the `id` value. */ - Id = 'ID', - /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. - */ - Relevance = 'RELEVANCE', -} - -/** Represents a generic custom attribute. */ -export type Attribute = { - __typename?: 'Attribute' - /** Key or name of the attribute. */ +export type MetadataItem = { + __typename?: 'MetadataItem' + /** Key of a metadata item. */ key: Scalars['String'] - /** Value of the attribute. */ - value?: Maybe -} - -/** Specifies the input fields required for an attribute. */ -export type AttributeInput = { - /** Key or name of the attribute. */ - key: Scalars['String'] - /** Value of the attribute. */ + /** Value of a metadata item. */ value: Scalars['String'] } -/** Automatic discount applications capture the intentions of a discount that was automatically applied. */ -export type AutomaticDiscountApplication = DiscountApplication & { - __typename?: 'AutomaticDiscountApplication' - /** The method by which the discount's value is allocated to its entitled items. */ - allocationMethod: DiscountApplicationAllocationMethod - /** Which lines of targetType that the discount is allocated over. */ - targetSelection: DiscountApplicationTargetSelection - /** The type of line that the discount is applicable towards. */ - targetType: DiscountApplicationTargetType - /** The title of the application. */ - title: Scalars['String'] - /** The value of the discount application. */ - value: PricingValue -} - -/** A collection of available shipping rates for a checkout. */ -export type AvailableShippingRates = { - __typename?: 'AvailableShippingRates' - /** - * Whether or not the shipping rates are ready. - * The `shippingRates` field is `null` when this value is `false`. - * This field should be polled until its value becomes `true`. - */ - ready: Scalars['Boolean'] - /** The fetched shipping rates. `null` until the `ready` field is `true`. */ - shippingRates?: Maybe> -} - -/** An online store blog. */ -export type Blog = Node & { - __typename?: 'Blog' - /** Find an article by its handle. */ - articleByHandle?: Maybe
- /** List of the blog's articles. */ - articles: ArticleConnection - /** The authors who have contributed to the blog. */ - authors: Array - /** A human-friendly unique string for the Blog automatically generated from its title. */ - handle: Scalars['String'] - /** Globally unique identifier. */ - id: Scalars['ID'] - /** The blog's SEO information. */ - seo?: Maybe - /** The blogs’s title. */ - title: Scalars['String'] - /** The url pointing to the blog accessible from the web. */ - url: Scalars['URL'] -} - -/** An online store blog. */ -export type BlogArticleByHandleArgs = { - handle: Scalars['String'] -} - -/** An online store blog. */ -export type BlogArticlesArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe -} - -/** An auto-generated type for paginating through multiple Blogs. */ -export type BlogConnection = { - __typename?: 'BlogConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** An auto-generated type which holds one Blog and a cursor during pagination. */ -export type BlogEdge = { - __typename?: 'BlogEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of BlogEdge. */ - node: Blog -} - -/** The set of valid sort keys for the Blog query. */ -export enum BlogSortKeys { - /** Sort by the `handle` value. */ - Handle = 'HANDLE', - /** Sort by the `title` value. */ - Title = 'TITLE', - /** Sort by the `id` value. */ - Id = 'ID', - /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. - */ - Relevance = 'RELEVANCE', -} - -/** Card brand, such as Visa or Mastercard, which can be used for payments. */ -export enum CardBrand { - /** Visa */ - Visa = 'VISA', - /** Mastercard */ - Mastercard = 'MASTERCARD', - /** Discover */ - Discover = 'DISCOVER', - /** American Express */ - AmericanExpress = 'AMERICAN_EXPRESS', - /** Diners Club */ - DinersClub = 'DINERS_CLUB', - /** JCB */ - Jcb = 'JCB', -} - -/** A container for all the information required to checkout items and pay. */ -export type Checkout = Node & { - __typename?: 'Checkout' - /** The gift cards used on the checkout. */ - appliedGiftCards: Array - /** - * The available shipping rates for this Checkout. - * Should only be used when checkout `requiresShipping` is `true` and - * the shipping address is valid. - */ - availableShippingRates?: Maybe - /** The date and time when the checkout was completed. */ - completedAt?: Maybe - /** The date and time when the checkout was created. */ - createdAt: Scalars['DateTime'] - /** The currency code for the Checkout. */ - currencyCode: CurrencyCode - /** A list of extra information that is added to the checkout. */ - customAttributes: Array - /** - * The customer associated with the checkout. - * @deprecated This field will always return null. If you have an authentication token for the customer, you can use the `customer` field on the query root to retrieve it. - */ - customer?: Maybe - /** Discounts that have been applied on the checkout. */ - discountApplications: DiscountApplicationConnection - /** The email attached to this checkout. */ - email?: Maybe - /** Globally unique identifier. */ - id: Scalars['ID'] - /** A list of line item objects, each one containing information about an item in the checkout. */ - lineItems: CheckoutLineItemConnection - /** The sum of all the prices of all the items in the checkout. Duties, taxes, shipping and discounts excluded. */ - lineItemsSubtotalPrice: MoneyV2 - /** The note associated with the checkout. */ - note?: Maybe - /** The resulting order from a paid checkout. */ - order?: Maybe - /** The Order Status Page for this Checkout, null when checkout is not completed. */ - orderStatusUrl?: Maybe - /** - * The amount left to be paid. This is equal to the cost of the line items, taxes and shipping minus discounts and gift cards. - * @deprecated Use `paymentDueV2` instead - */ - paymentDue: Scalars['Money'] - /** The amount left to be paid. This is equal to the cost of the line items, duties, taxes and shipping minus discounts and gift cards. */ - paymentDueV2: MoneyV2 - /** - * Whether or not the Checkout is ready and can be completed. Checkouts may - * have asynchronous operations that can take time to finish. If you want - * to complete a checkout or ensure all the fields are populated and up to - * date, polling is required until the value is true. - */ - ready: Scalars['Boolean'] - /** States whether or not the fulfillment requires shipping. */ - requiresShipping: Scalars['Boolean'] - /** The shipping address to where the line items will be shipped. */ - shippingAddress?: Maybe - /** The discounts that have been allocated onto the shipping line by discount applications. */ - shippingDiscountAllocations: Array - /** Once a shipping rate is selected by the customer it is transitioned to a `shipping_line` object. */ - shippingLine?: Maybe - /** - * Price of the checkout before shipping and taxes. - * @deprecated Use `subtotalPriceV2` instead - */ - subtotalPrice: Scalars['Money'] - /** Price of the checkout before duties, shipping and taxes. */ - subtotalPriceV2: MoneyV2 - /** Specifies if the Checkout is tax exempt. */ - taxExempt: Scalars['Boolean'] - /** Specifies if taxes are included in the line item and shipping line prices. */ - taxesIncluded: Scalars['Boolean'] - /** - * The sum of all the prices of all the items in the checkout, taxes and discounts included. - * @deprecated Use `totalPriceV2` instead - */ - totalPrice: Scalars['Money'] - /** The sum of all the prices of all the items in the checkout, duties, taxes and discounts included. */ - totalPriceV2: MoneyV2 - /** - * The sum of all the taxes applied to the line items and shipping lines in the checkout. - * @deprecated Use `totalTaxV2` instead - */ - totalTax: Scalars['Money'] - /** The sum of all the taxes applied to the line items and shipping lines in the checkout. */ - totalTaxV2: MoneyV2 - /** The date and time when the checkout was last updated. */ - updatedAt: Scalars['DateTime'] - /** The url pointing to the checkout accessible from the web. */ - webUrl: Scalars['URL'] -} - -/** A container for all the information required to checkout items and pay. */ -export type CheckoutDiscountApplicationsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe -} - -/** A container for all the information required to checkout items and pay. */ -export type CheckoutLineItemsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe -} - -/** Specifies the fields required to update a checkout's attributes. */ -export type CheckoutAttributesUpdateInput = { - /** The text of an optional note that a shop owner can attach to the checkout. */ - note?: Maybe - /** A list of extra information that is added to the checkout. */ - customAttributes?: Maybe> - /** - * Allows setting partial addresses on a Checkout, skipping the full validation of attributes. - * The required attributes are city, province, and country. - * Full validation of the addresses is still done at complete time. - */ - allowPartialAddresses?: Maybe -} - -/** Return type for `checkoutAttributesUpdate` mutation. */ -export type CheckoutAttributesUpdatePayload = { - __typename?: 'CheckoutAttributesUpdatePayload' - /** The updated checkout object. */ - checkout: Checkout - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Specifies the fields required to update a checkout's attributes. */ -export type CheckoutAttributesUpdateV2Input = { - /** The text of an optional note that a shop owner can attach to the checkout. */ - note?: Maybe - /** A list of extra information that is added to the checkout. */ - customAttributes?: Maybe> - /** - * Allows setting partial addresses on a Checkout, skipping the full validation of attributes. - * The required attributes are city, province, and country. - * Full validation of the addresses is still done at complete time. - */ - allowPartialAddresses?: Maybe -} - -/** Return type for `checkoutAttributesUpdateV2` mutation. */ -export type CheckoutAttributesUpdateV2Payload = { - __typename?: 'CheckoutAttributesUpdateV2Payload' - /** The updated checkout object. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutCompleteFree` mutation. */ -export type CheckoutCompleteFreePayload = { - __typename?: 'CheckoutCompleteFreePayload' - /** The updated checkout object. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutCompleteWithCreditCard` mutation. */ -export type CheckoutCompleteWithCreditCardPayload = { - __typename?: 'CheckoutCompleteWithCreditCardPayload' - /** The checkout on which the payment was applied. */ - checkout: Checkout - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** A representation of the attempted payment. */ - payment?: Maybe - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutCompleteWithCreditCardV2` mutation. */ -export type CheckoutCompleteWithCreditCardV2Payload = { - __typename?: 'CheckoutCompleteWithCreditCardV2Payload' - /** The checkout on which the payment was applied. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** A representation of the attempted payment. */ - payment?: Maybe - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutCompleteWithTokenizedPayment` mutation. */ -export type CheckoutCompleteWithTokenizedPaymentPayload = { - __typename?: 'CheckoutCompleteWithTokenizedPaymentPayload' - /** The checkout on which the payment was applied. */ - checkout: Checkout - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** A representation of the attempted payment. */ - payment?: Maybe - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutCompleteWithTokenizedPaymentV2` mutation. */ -export type CheckoutCompleteWithTokenizedPaymentV2Payload = { - __typename?: 'CheckoutCompleteWithTokenizedPaymentV2Payload' - /** The checkout on which the payment was applied. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** A representation of the attempted payment. */ - payment?: Maybe - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutCompleteWithTokenizedPaymentV3` mutation. */ -export type CheckoutCompleteWithTokenizedPaymentV3Payload = { - __typename?: 'CheckoutCompleteWithTokenizedPaymentV3Payload' - /** The checkout on which the payment was applied. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** A representation of the attempted payment. */ - payment?: Maybe - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Specifies the fields required to create a checkout. */ -export type CheckoutCreateInput = { - /** The email with which the customer wants to checkout. */ - email?: Maybe - /** A list of line item objects, each one containing information about an item in the checkout. */ - lineItems?: Maybe> - /** The shipping address to where the line items will be shipped. */ - shippingAddress?: Maybe - /** The text of an optional note that a shop owner can attach to the checkout. */ - note?: Maybe - /** A list of extra information that is added to the checkout. */ - customAttributes?: Maybe> - /** - * Allows setting partial addresses on a Checkout, skipping the full validation of attributes. - * The required attributes are city, province, and country. - * Full validation of addresses is still done at complete time. - */ - allowPartialAddresses?: Maybe - /** - * The three-letter currency code of one of the shop's enabled presentment currencies. - * Including this field creates a checkout in the specified currency. By default, new - * checkouts are created in the shop's primary currency. - */ - presentmentCurrencyCode?: Maybe -} - -/** Return type for `checkoutCreate` mutation. */ -export type CheckoutCreatePayload = { - __typename?: 'CheckoutCreatePayload' - /** The new checkout object. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutCustomerAssociate` mutation. */ -export type CheckoutCustomerAssociatePayload = { - __typename?: 'CheckoutCustomerAssociatePayload' - /** The updated checkout object. */ - checkout: Checkout - /** The associated customer object. */ - customer?: Maybe - /** List of errors that occurred executing the mutation. */ - userErrors: Array -} - -/** Return type for `checkoutCustomerAssociateV2` mutation. */ -export type CheckoutCustomerAssociateV2Payload = { - __typename?: 'CheckoutCustomerAssociateV2Payload' - /** The updated checkout object. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** The associated customer object. */ - customer?: Maybe - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutCustomerDisassociate` mutation. */ -export type CheckoutCustomerDisassociatePayload = { - __typename?: 'CheckoutCustomerDisassociatePayload' - /** The updated checkout object. */ - checkout: Checkout - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutCustomerDisassociateV2` mutation. */ -export type CheckoutCustomerDisassociateV2Payload = { - __typename?: 'CheckoutCustomerDisassociateV2Payload' - /** The updated checkout object. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutDiscountCodeApply` mutation. */ -export type CheckoutDiscountCodeApplyPayload = { - __typename?: 'CheckoutDiscountCodeApplyPayload' - /** The updated checkout object. */ - checkout: Checkout - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutDiscountCodeApplyV2` mutation. */ -export type CheckoutDiscountCodeApplyV2Payload = { - __typename?: 'CheckoutDiscountCodeApplyV2Payload' - /** The updated checkout object. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutDiscountCodeRemove` mutation. */ -export type CheckoutDiscountCodeRemovePayload = { - __typename?: 'CheckoutDiscountCodeRemovePayload' - /** The updated checkout object. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutEmailUpdate` mutation. */ -export type CheckoutEmailUpdatePayload = { - __typename?: 'CheckoutEmailUpdatePayload' - /** The checkout object with the updated email. */ - checkout: Checkout - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutEmailUpdateV2` mutation. */ -export type CheckoutEmailUpdateV2Payload = { - __typename?: 'CheckoutEmailUpdateV2Payload' - /** The checkout object with the updated email. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Possible error codes that could be returned by CheckoutUserError. */ -export enum CheckoutErrorCode { - /** Input value is blank. */ - Blank = 'BLANK', - /** Input value is invalid. */ - Invalid = 'INVALID', - /** Input value is too long. */ - TooLong = 'TOO_LONG', - /** Input value is not present. */ - Present = 'PRESENT', - /** Input value should be less than maximum allowed value. */ - LessThan = 'LESS_THAN', - /** Input value should be greater than or equal to minimum allowed value. */ - GreaterThanOrEqualTo = 'GREATER_THAN_OR_EQUAL_TO', - /** Input value should be less or equal to maximum allowed value. */ - LessThanOrEqualTo = 'LESS_THAN_OR_EQUAL_TO', - /** Checkout is already completed. */ - AlreadyCompleted = 'ALREADY_COMPLETED', - /** Checkout is locked. */ - Locked = 'LOCKED', - /** Input value is not supported. */ - NotSupported = 'NOT_SUPPORTED', - /** Input email contains an invalid domain name. */ - BadDomain = 'BAD_DOMAIN', - /** Input Zip is invalid for country provided. */ - InvalidForCountry = 'INVALID_FOR_COUNTRY', - /** Input Zip is invalid for country and province provided. */ - InvalidForCountryAndProvince = 'INVALID_FOR_COUNTRY_AND_PROVINCE', - /** Invalid state in country. */ - InvalidStateInCountry = 'INVALID_STATE_IN_COUNTRY', - /** Invalid province in country. */ - InvalidProvinceInCountry = 'INVALID_PROVINCE_IN_COUNTRY', - /** Invalid region in country. */ - InvalidRegionInCountry = 'INVALID_REGION_IN_COUNTRY', - /** Shipping rate expired. */ - ShippingRateExpired = 'SHIPPING_RATE_EXPIRED', - /** Gift card cannot be applied to a checkout that contains a gift card. */ - GiftCardUnusable = 'GIFT_CARD_UNUSABLE', - /** Gift card is disabled. */ - GiftCardDisabled = 'GIFT_CARD_DISABLED', - /** Gift card code is invalid. */ - GiftCardCodeInvalid = 'GIFT_CARD_CODE_INVALID', - /** Gift card has already been applied. */ - GiftCardAlreadyApplied = 'GIFT_CARD_ALREADY_APPLIED', - /** Gift card currency does not match checkout currency. */ - GiftCardCurrencyMismatch = 'GIFT_CARD_CURRENCY_MISMATCH', - /** Gift card is expired. */ - GiftCardExpired = 'GIFT_CARD_EXPIRED', - /** Gift card has no funds left. */ - GiftCardDepleted = 'GIFT_CARD_DEPLETED', - /** Gift card was not found. */ - GiftCardNotFound = 'GIFT_CARD_NOT_FOUND', - /** Cart does not meet discount requirements notice. */ - CartDoesNotMeetDiscountRequirementsNotice = 'CART_DOES_NOT_MEET_DISCOUNT_REQUIREMENTS_NOTICE', - /** Discount expired. */ - DiscountExpired = 'DISCOUNT_EXPIRED', - /** Discount disabled. */ - DiscountDisabled = 'DISCOUNT_DISABLED', - /** Discount limit reached. */ - DiscountLimitReached = 'DISCOUNT_LIMIT_REACHED', - /** Discount not found. */ - DiscountNotFound = 'DISCOUNT_NOT_FOUND', - /** Customer already used once per customer discount notice. */ - CustomerAlreadyUsedOncePerCustomerDiscountNotice = 'CUSTOMER_ALREADY_USED_ONCE_PER_CUSTOMER_DISCOUNT_NOTICE', - /** Checkout is already completed. */ - Empty = 'EMPTY', - /** Not enough in stock. */ - NotEnoughInStock = 'NOT_ENOUGH_IN_STOCK', - /** Missing payment input. */ - MissingPaymentInput = 'MISSING_PAYMENT_INPUT', - /** The amount of the payment does not match the value to be paid. */ - TotalPriceMismatch = 'TOTAL_PRICE_MISMATCH', - /** Line item was not found in checkout. */ - LineItemNotFound = 'LINE_ITEM_NOT_FOUND', - /** Unable to apply discount. */ - UnableToApply = 'UNABLE_TO_APPLY', - /** Discount already applied. */ - DiscountAlreadyApplied = 'DISCOUNT_ALREADY_APPLIED', -} - -/** Return type for `checkoutGiftCardApply` mutation. */ -export type CheckoutGiftCardApplyPayload = { - __typename?: 'CheckoutGiftCardApplyPayload' - /** The updated checkout object. */ - checkout: Checkout - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutGiftCardRemove` mutation. */ -export type CheckoutGiftCardRemovePayload = { - __typename?: 'CheckoutGiftCardRemovePayload' - /** The updated checkout object. */ - checkout: Checkout - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutGiftCardRemoveV2` mutation. */ -export type CheckoutGiftCardRemoveV2Payload = { - __typename?: 'CheckoutGiftCardRemoveV2Payload' - /** The updated checkout object. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutGiftCardsAppend` mutation. */ -export type CheckoutGiftCardsAppendPayload = { - __typename?: 'CheckoutGiftCardsAppendPayload' - /** The updated checkout object. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** A single line item in the checkout, grouped by variant and attributes. */ -export type CheckoutLineItem = Node & { - __typename?: 'CheckoutLineItem' - /** Extra information in the form of an array of Key-Value pairs about the line item. */ - customAttributes: Array - /** The discounts that have been allocated onto the checkout line item by discount applications. */ - discountAllocations: Array - /** Globally unique identifier. */ - id: Scalars['ID'] - /** The quantity of the line item. */ - quantity: Scalars['Int'] - /** Title of the line item. Defaults to the product's title. */ - title: Scalars['String'] - /** Unit price of the line item. */ - unitPrice?: Maybe - /** Product variant of the line item. */ - variant?: Maybe -} - -/** An auto-generated type for paginating through multiple CheckoutLineItems. */ -export type CheckoutLineItemConnection = { - __typename?: 'CheckoutLineItemConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** An auto-generated type which holds one CheckoutLineItem and a cursor during pagination. */ -export type CheckoutLineItemEdge = { - __typename?: 'CheckoutLineItemEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of CheckoutLineItemEdge. */ - node: CheckoutLineItem -} - -/** Specifies the input fields to create a line item on a checkout. */ -export type CheckoutLineItemInput = { - /** Extra information in the form of an array of Key-Value pairs about the line item. */ - customAttributes?: Maybe> - /** The quantity of the line item. */ - quantity: Scalars['Int'] - /** The identifier of the product variant for the line item. */ - variantId: Scalars['ID'] -} - -/** Specifies the input fields to update a line item on the checkout. */ -export type CheckoutLineItemUpdateInput = { - /** The identifier of the line item. */ - id?: Maybe - /** The variant identifier of the line item. */ - variantId?: Maybe - /** The quantity of the line item. */ - quantity?: Maybe - /** Extra information in the form of an array of Key-Value pairs about the line item. */ - customAttributes?: Maybe> -} - -/** Return type for `checkoutLineItemsAdd` mutation. */ -export type CheckoutLineItemsAddPayload = { - __typename?: 'CheckoutLineItemsAddPayload' - /** The updated checkout object. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutLineItemsRemove` mutation. */ -export type CheckoutLineItemsRemovePayload = { - __typename?: 'CheckoutLineItemsRemovePayload' - /** The updated checkout object. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutLineItemsReplace` mutation. */ -export type CheckoutLineItemsReplacePayload = { - __typename?: 'CheckoutLineItemsReplacePayload' - /** The updated checkout object. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - userErrors: Array -} - -/** Return type for `checkoutLineItemsUpdate` mutation. */ -export type CheckoutLineItemsUpdatePayload = { - __typename?: 'CheckoutLineItemsUpdatePayload' - /** The updated checkout object. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutShippingAddressUpdate` mutation. */ -export type CheckoutShippingAddressUpdatePayload = { - __typename?: 'CheckoutShippingAddressUpdatePayload' - /** The updated checkout object. */ - checkout: Checkout - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutShippingAddressUpdateV2` mutation. */ -export type CheckoutShippingAddressUpdateV2Payload = { - __typename?: 'CheckoutShippingAddressUpdateV2Payload' - /** The updated checkout object. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `checkoutShippingLineUpdate` mutation. */ -export type CheckoutShippingLineUpdatePayload = { - __typename?: 'CheckoutShippingLineUpdatePayload' - /** The updated checkout object. */ - checkout?: Maybe - /** List of errors that occurred executing the mutation. */ - checkoutUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `checkoutUserErrors` instead - */ - userErrors: Array -} - -/** Represents an error that happens during execution of a checkout mutation. */ -export type CheckoutUserError = DisplayableError & { - __typename?: 'CheckoutUserError' - /** Error code to uniquely identify the error. */ - code?: Maybe - /** Path to the input field which caused the error. */ - field?: Maybe> - /** The error message. */ - message: Scalars['String'] -} - -/** A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse. */ -export type Collection = Node & { - __typename?: 'Collection' - /** Stripped description of the collection, single line with HTML tags removed. */ - description: Scalars['String'] - /** The description of the collection, complete with HTML formatting. */ - descriptionHtml: Scalars['HTML'] - /** - * A human-friendly unique string for the collection automatically generated from its title. - * Limit of 255 characters. - */ - handle: Scalars['String'] - /** Globally unique identifier. */ - id: Scalars['ID'] - /** Image associated with the collection. */ - image?: Maybe - /** List of products in the collection. */ - products: ProductConnection - /** The collection’s name. Limit of 255 characters. */ - title: Scalars['String'] - /** The date and time when the collection was last modified. */ - updatedAt: Scalars['DateTime'] -} - -/** A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse. */ -export type CollectionDescriptionArgs = { - truncateAt?: Maybe -} - -/** A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse. */ -export type CollectionImageArgs = { - maxWidth?: Maybe - maxHeight?: Maybe - crop?: Maybe - scale?: Maybe -} - -/** A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse. */ -export type CollectionProductsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe -} - -/** An auto-generated type for paginating through multiple Collections. */ -export type CollectionConnection = { - __typename?: 'CollectionConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** An auto-generated type which holds one Collection and a cursor during pagination. */ -export type CollectionEdge = { - __typename?: 'CollectionEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of CollectionEdge. */ - node: Collection -} - -/** The set of valid sort keys for the Collection query. */ -export enum CollectionSortKeys { - /** Sort by the `title` value. */ - Title = 'TITLE', - /** Sort by the `updated_at` value. */ - UpdatedAt = 'UPDATED_AT', - /** Sort by the `id` value. */ - Id = 'ID', - /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. - */ - Relevance = 'RELEVANCE', -} - -/** A comment on an article. */ -export type Comment = Node & { - __typename?: 'Comment' - /** The comment’s author. */ - author: CommentAuthor - /** Stripped content of the comment, single line with HTML tags removed. */ - content: Scalars['String'] - /** The content of the comment, complete with HTML formatting. */ - contentHtml: Scalars['HTML'] - /** Globally unique identifier. */ - id: Scalars['ID'] -} - -/** A comment on an article. */ -export type CommentContentArgs = { - truncateAt?: Maybe -} - -/** The author of a comment. */ -export type CommentAuthor = { - __typename?: 'CommentAuthor' - /** The author's email. */ - email: Scalars['String'] - /** The author’s name. */ +/** Represents a permission object in a friendly form. */ +export type Permission = { + __typename?: 'Permission' + /** Internal code for permission. */ + code: PermissionEnum + /** Describe action(s) allowed to do by permission. */ name: Scalars['String'] } -/** An auto-generated type for paginating through multiple Comments. */ -export type CommentConnection = { - __typename?: 'CommentConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo +/** An enumeration. */ +export enum PermissionEnum { + ManageUsers = 'MANAGE_USERS', + ManageStaff = 'MANAGE_STAFF', + ManageApps = 'MANAGE_APPS', + ManageChannels = 'MANAGE_CHANNELS', + ManageDiscounts = 'MANAGE_DISCOUNTS', + ManagePlugins = 'MANAGE_PLUGINS', + ManageGiftCard = 'MANAGE_GIFT_CARD', + ManageMenus = 'MANAGE_MENUS', + ManageOrders = 'MANAGE_ORDERS', + ManagePages = 'MANAGE_PAGES', + ManagePageTypesAndAttributes = 'MANAGE_PAGE_TYPES_AND_ATTRIBUTES', + ManageProducts = 'MANAGE_PRODUCTS', + ManageProductTypesAndAttributes = 'MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES', + ManageShipping = 'MANAGE_SHIPPING', + ManageSettings = 'MANAGE_SETTINGS', + ManageTranslations = 'MANAGE_TRANSLATIONS', + ManageCheckouts = 'MANAGE_CHECKOUTS', } -/** An auto-generated type which holds one Comment and a cursor during pagination. */ -export type CommentEdge = { - __typename?: 'CommentEdge' +/** Represents token data. */ +export type AppToken = Node & { + __typename?: 'AppToken' + /** Name of the authenticated token. */ + name?: Maybe + /** Last 4 characters of the token. */ + authToken?: Maybe + /** The ID of the object. */ + id: Scalars['ID'] +} + +/** Enum determining type of your App. */ +export enum AppTypeEnum { + /** Local Saleor App. The app is fully manageable from dashboard. You can change assigned permissions, add webhooks, or authentication token */ + Local = 'LOCAL', + /** Third party external App. Installation is fully automated. Saleor uses a defined App manifest to gather all required information. */ + Thirdparty = 'THIRDPARTY', +} + +/** An enumeration. */ +export enum WebhookSampleEventTypeEnum { + OrderCreated = 'ORDER_CREATED', + OrderConfirmed = 'ORDER_CONFIRMED', + OrderFullyPaid = 'ORDER_FULLY_PAID', + OrderUpdated = 'ORDER_UPDATED', + OrderCancelled = 'ORDER_CANCELLED', + OrderFulfilled = 'ORDER_FULFILLED', + InvoiceRequested = 'INVOICE_REQUESTED', + InvoiceDeleted = 'INVOICE_DELETED', + InvoiceSent = 'INVOICE_SENT', + CustomerCreated = 'CUSTOMER_CREATED', + CustomerUpdated = 'CUSTOMER_UPDATED', + ProductCreated = 'PRODUCT_CREATED', + ProductUpdated = 'PRODUCT_UPDATED', + ProductDeleted = 'PRODUCT_DELETED', + ProductVariantCreated = 'PRODUCT_VARIANT_CREATED', + ProductVariantUpdated = 'PRODUCT_VARIANT_UPDATED', + ProductVariantDeleted = 'PRODUCT_VARIANT_DELETED', + CheckoutCreated = 'CHECKOUT_CREATED', + CheckoutUpdated = 'CHECKOUT_UPDATED', + FulfillmentCreated = 'FULFILLMENT_CREATED', + NotifyUser = 'NOTIFY_USER', + PageCreated = 'PAGE_CREATED', + PageUpdated = 'PAGE_UPDATED', + PageDeleted = 'PAGE_DELETED', +} + +/** Represents warehouse. */ +export type Warehouse = Node & + ObjectWithMetadata & { + __typename?: 'Warehouse' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + slug: Scalars['String'] + companyName: Scalars['String'] + shippingZones: ShippingZoneCountableConnection + address: Address + email: Scalars['String'] + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + } + +/** Represents warehouse. */ +export type WarehouseShippingZonesArgs = { + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type ShippingZoneCountableConnection = { + __typename?: 'ShippingZoneCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +/** The Relay compliant `PageInfo` type, containing data necessary to paginate this connection. */ +export type PageInfo = { + __typename?: 'PageInfo' + /** When paginating forwards, are there more items? */ + hasNextPage: Scalars['Boolean'] + /** When paginating backwards, are there more items? */ + hasPreviousPage: Scalars['Boolean'] + /** When paginating backwards, the cursor to continue. */ + startCursor?: Maybe + /** When paginating forwards, the cursor to continue. */ + endCursor?: Maybe +} + +export type ShippingZoneCountableEdge = { + __typename?: 'ShippingZoneCountableEdge' + /** The item at the end of the edge. */ + node: ShippingZone /** A cursor for use in pagination. */ cursor: Scalars['String'] - /** The item at the end of CommentEdge. */ - node: Comment } -/** ISO 3166-1 alpha-2 country codes with some differences. */ -export enum CountryCode { - /** Afghanistan. */ - Af = 'AF', - /** Åland Islands. */ - Ax = 'AX', - /** Albania. */ - Al = 'AL', - /** Algeria. */ - Dz = 'DZ', - /** Andorra. */ - Ad = 'AD', - /** Angola. */ - Ao = 'AO', - /** Anguilla. */ - Ai = 'AI', - /** Antigua & Barbuda. */ - Ag = 'AG', - /** Argentina. */ - Ar = 'AR', - /** Armenia. */ - Am = 'AM', - /** Aruba. */ - Aw = 'AW', - /** Australia. */ - Au = 'AU', - /** Austria. */ - At = 'AT', - /** Azerbaijan. */ - Az = 'AZ', - /** Bahamas. */ - Bs = 'BS', - /** Bahrain. */ - Bh = 'BH', - /** Bangladesh. */ - Bd = 'BD', - /** Barbados. */ - Bb = 'BB', - /** Belarus. */ - By = 'BY', - /** Belgium. */ - Be = 'BE', - /** Belize. */ - Bz = 'BZ', - /** Benin. */ - Bj = 'BJ', - /** Bermuda. */ - Bm = 'BM', - /** Bhutan. */ - Bt = 'BT', - /** Bolivia. */ - Bo = 'BO', - /** Bosnia & Herzegovina. */ - Ba = 'BA', - /** Botswana. */ - Bw = 'BW', - /** Bouvet Island. */ - Bv = 'BV', - /** Brazil. */ - Br = 'BR', - /** British Indian Ocean Territory. */ - Io = 'IO', - /** Brunei. */ - Bn = 'BN', - /** Bulgaria. */ - Bg = 'BG', - /** Burkina Faso. */ - Bf = 'BF', - /** Burundi. */ - Bi = 'BI', - /** Cambodia. */ - Kh = 'KH', - /** Canada. */ - Ca = 'CA', - /** Cape Verde. */ - Cv = 'CV', - /** Caribbean Netherlands. */ - Bq = 'BQ', - /** Cayman Islands. */ - Ky = 'KY', - /** Central African Republic. */ - Cf = 'CF', - /** Chad. */ - Td = 'TD', - /** Chile. */ - Cl = 'CL', - /** China. */ - Cn = 'CN', - /** Christmas Island. */ - Cx = 'CX', - /** Cocos (Keeling) Islands. */ - Cc = 'CC', - /** Colombia. */ - Co = 'CO', - /** Comoros. */ - Km = 'KM', - /** Congo - Brazzaville. */ - Cg = 'CG', - /** Congo - Kinshasa. */ - Cd = 'CD', - /** Cook Islands. */ - Ck = 'CK', - /** Costa Rica. */ - Cr = 'CR', - /** Croatia. */ - Hr = 'HR', - /** Cuba. */ - Cu = 'CU', - /** Curaçao. */ - Cw = 'CW', - /** Cyprus. */ - Cy = 'CY', - /** Czechia. */ - Cz = 'CZ', - /** Côte d’Ivoire. */ - Ci = 'CI', - /** Denmark. */ - Dk = 'DK', - /** Djibouti. */ - Dj = 'DJ', - /** Dominica. */ - Dm = 'DM', - /** Dominican Republic. */ - Do = 'DO', - /** Ecuador. */ - Ec = 'EC', - /** Egypt. */ - Eg = 'EG', - /** El Salvador. */ - Sv = 'SV', - /** Equatorial Guinea. */ - Gq = 'GQ', - /** Eritrea. */ - Er = 'ER', - /** Estonia. */ - Ee = 'EE', - /** Eswatini. */ - Sz = 'SZ', - /** Ethiopia. */ - Et = 'ET', - /** Falkland Islands. */ - Fk = 'FK', - /** Faroe Islands. */ - Fo = 'FO', - /** Fiji. */ - Fj = 'FJ', - /** Finland. */ - Fi = 'FI', - /** France. */ - Fr = 'FR', - /** French Guiana. */ - Gf = 'GF', - /** French Polynesia. */ - Pf = 'PF', - /** French Southern Territories. */ - Tf = 'TF', - /** Gabon. */ - Ga = 'GA', - /** Gambia. */ - Gm = 'GM', - /** Georgia. */ - Ge = 'GE', - /** Germany. */ - De = 'DE', - /** Ghana. */ - Gh = 'GH', - /** Gibraltar. */ - Gi = 'GI', - /** Greece. */ - Gr = 'GR', - /** Greenland. */ - Gl = 'GL', - /** Grenada. */ - Gd = 'GD', - /** Guadeloupe. */ - Gp = 'GP', - /** Guatemala. */ - Gt = 'GT', - /** Guernsey. */ - Gg = 'GG', - /** Guinea. */ - Gn = 'GN', - /** Guinea-Bissau. */ - Gw = 'GW', - /** Guyana. */ - Gy = 'GY', - /** Haiti. */ - Ht = 'HT', - /** Heard & McDonald Islands. */ - Hm = 'HM', - /** Vatican City. */ - Va = 'VA', - /** Honduras. */ - Hn = 'HN', - /** Hong Kong SAR. */ - Hk = 'HK', - /** Hungary. */ - Hu = 'HU', - /** Iceland. */ - Is = 'IS', - /** India. */ - In = 'IN', - /** Indonesia. */ - Id = 'ID', - /** Iran. */ - Ir = 'IR', - /** Iraq. */ - Iq = 'IQ', - /** Ireland. */ - Ie = 'IE', - /** Isle of Man. */ - Im = 'IM', - /** Israel. */ - Il = 'IL', - /** Italy. */ - It = 'IT', - /** Jamaica. */ - Jm = 'JM', - /** Japan. */ - Jp = 'JP', - /** Jersey. */ - Je = 'JE', - /** Jordan. */ - Jo = 'JO', - /** Kazakhstan. */ - Kz = 'KZ', - /** Kenya. */ - Ke = 'KE', - /** Kiribati. */ - Ki = 'KI', - /** North Korea. */ - Kp = 'KP', - /** Kosovo. */ - Xk = 'XK', - /** Kuwait. */ - Kw = 'KW', - /** Kyrgyzstan. */ +/** Represents a shipping zone in the shop. Zones are the concept used only for grouping shipping methods in the dashboard, and are never exposed to the customers directly. */ +export type ShippingZone = Node & + ObjectWithMetadata & { + __typename?: 'ShippingZone' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + default: Scalars['Boolean'] + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + /** Lowest and highest prices for the shipping. */ + priceRange?: Maybe + /** List of countries available for the method. */ + countries?: Maybe>> + /** List of shipping methods available for orders shipped to countries within this shipping zone. */ + shippingMethods?: Maybe>> + /** List of warehouses for shipping zone. */ + warehouses: Array + /** List of channels for shipping zone. */ + channels: Array + /** Description of a shipping zone. */ + description?: Maybe + } + +/** Represents a range of amounts of money. */ +export type MoneyRange = { + __typename?: 'MoneyRange' + /** Lower bound of a price range. */ + start?: Maybe + /** Upper bound of a price range. */ + stop?: Maybe +} + +/** Represents amount of money in specific currency. */ +export type Money = { + __typename?: 'Money' + /** Currency code. */ + currency: Scalars['String'] + /** Amount of money. */ + amount: Scalars['Float'] + /** + * Money formatted according to the current locale. + * @deprecated Price formatting according to the current locale should be handled by the frontend client. This field will be removed after 2020-07-31. + */ + localized: Scalars['String'] +} + +export type CountryDisplay = { + __typename?: 'CountryDisplay' + /** Country code. */ + code: Scalars['String'] + /** Country name. */ + country: Scalars['String'] + /** Country tax. */ + vat?: Maybe +} + +/** Represents a VAT rate for a country. */ +export type Vat = { + __typename?: 'VAT' + /** Country code. */ + countryCode: Scalars['String'] + /** Standard VAT rate in percent. */ + standardRate?: Maybe + /** Country's VAT rate exceptions for specific types of goods. */ + reducedRates: Array> +} + +/** Represents a reduced VAT rate for a particular type of goods. */ +export type ReducedRate = { + __typename?: 'ReducedRate' + /** Reduced VAT rate in percent. */ + rate: Scalars['Float'] + /** A type of goods. */ + rateType: TaxRateType +} + +/** An enumeration. */ +export enum TaxRateType { + Accommodation = 'ACCOMMODATION', + AdmissionToCulturalEvents = 'ADMISSION_TO_CULTURAL_EVENTS', + AdmissionToEntertainmentEvents = 'ADMISSION_TO_ENTERTAINMENT_EVENTS', + AdmissionToSportingEvents = 'ADMISSION_TO_SPORTING_EVENTS', + Advertising = 'ADVERTISING', + AgriculturalSupplies = 'AGRICULTURAL_SUPPLIES', + BabyFoodstuffs = 'BABY_FOODSTUFFS', + Bikes = 'BIKES', + Books = 'BOOKS', + ChildrensClothing = 'CHILDRENS_CLOTHING', + DomesticFuel = 'DOMESTIC_FUEL', + DomesticServices = 'DOMESTIC_SERVICES', + EBooks = 'E_BOOKS', + Foodstuffs = 'FOODSTUFFS', + Hotels = 'HOTELS', + Medical = 'MEDICAL', + Newspapers = 'NEWSPAPERS', + PassengerTransport = 'PASSENGER_TRANSPORT', + Pharmaceuticals = 'PHARMACEUTICALS', + PropertyRenovations = 'PROPERTY_RENOVATIONS', + Restaurants = 'RESTAURANTS', + SocialHousing = 'SOCIAL_HOUSING', + Standard = 'STANDARD', + Water = 'WATER', + Wine = 'WINE', +} + +/** Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers. */ +export type ShippingMethod = Node & + ObjectWithMetadata & { + __typename?: 'ShippingMethod' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + minimumOrderWeight?: Maybe + maximumOrderWeight?: Maybe + maximumDeliveryDays?: Maybe + minimumDeliveryDays?: Maybe + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + /** Type of the shipping method. */ + type?: Maybe + /** Returns translated shipping method fields for the given language code. */ + translation?: Maybe + /** List of channels available for the method. */ + channelListings?: Maybe> + /** The price of the cheapest variant (including discounts). */ + price?: Maybe + /** The price of the cheapest variant (including discounts). */ + maximumOrderPrice?: Maybe + /** The price of the cheapest variant (including discounts). */ + minimumOrderPrice?: Maybe + /** Postal code ranges rule of exclusion or inclusion of the shipping method. */ + postalCodeRules?: Maybe>> + /** List of excluded products for the shipping method. */ + excludedProducts?: Maybe + } + +/** Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers. */ +export type ShippingMethodTranslationArgs = { + languageCode: LanguageCodeEnum +} + +/** Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers. */ +export type ShippingMethodExcludedProductsArgs = { + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +/** Represents weight value in a specific weight unit. */ +export type Weight = { + __typename?: 'Weight' + /** Weight unit. */ + unit: WeightUnitsEnum + /** Weight value. */ + value: Scalars['Float'] +} + +/** An enumeration. */ +export enum WeightUnitsEnum { Kg = 'KG', - /** Laos. */ - La = 'LA', - /** Latvia. */ - Lv = 'LV', - /** Lebanon. */ Lb = 'LB', - /** Lesotho. */ - Ls = 'LS', - /** Liberia. */ - Lr = 'LR', - /** Libya. */ - Ly = 'LY', - /** Liechtenstein. */ - Li = 'LI', - /** Lithuania. */ - Lt = 'LT', - /** Luxembourg. */ - Lu = 'LU', - /** Macao SAR. */ - Mo = 'MO', - /** Madagascar. */ - Mg = 'MG', - /** Malawi. */ - Mw = 'MW', - /** Malaysia. */ - My = 'MY', - /** Maldives. */ - Mv = 'MV', - /** Mali. */ - Ml = 'ML', - /** Malta. */ - Mt = 'MT', - /** Martinique. */ - Mq = 'MQ', - /** Mauritania. */ - Mr = 'MR', - /** Mauritius. */ - Mu = 'MU', - /** Mayotte. */ - Yt = 'YT', - /** Mexico. */ - Mx = 'MX', - /** Moldova. */ - Md = 'MD', - /** Monaco. */ - Mc = 'MC', - /** Mongolia. */ - Mn = 'MN', - /** Montenegro. */ - Me = 'ME', - /** Montserrat. */ - Ms = 'MS', - /** Morocco. */ - Ma = 'MA', - /** Mozambique. */ - Mz = 'MZ', - /** Myanmar (Burma). */ - Mm = 'MM', - /** Namibia. */ - Na = 'NA', - /** Nauru. */ - Nr = 'NR', - /** Nepal. */ - Np = 'NP', - /** Netherlands. */ - Nl = 'NL', - /** Netherlands Antilles. */ - An = 'AN', - /** New Caledonia. */ - Nc = 'NC', - /** New Zealand. */ - Nz = 'NZ', - /** Nicaragua. */ - Ni = 'NI', - /** Niger. */ - Ne = 'NE', - /** Nigeria. */ - Ng = 'NG', - /** Niue. */ - Nu = 'NU', - /** Norfolk Island. */ - Nf = 'NF', - /** North Macedonia. */ - Mk = 'MK', - /** Norway. */ - No = 'NO', - /** Oman. */ - Om = 'OM', - /** Pakistan. */ - Pk = 'PK', - /** Palestinian Territories. */ - Ps = 'PS', - /** Panama. */ - Pa = 'PA', - /** Papua New Guinea. */ - Pg = 'PG', - /** Paraguay. */ - Py = 'PY', - /** Peru. */ - Pe = 'PE', - /** Philippines. */ - Ph = 'PH', - /** Pitcairn Islands. */ - Pn = 'PN', - /** Poland. */ - Pl = 'PL', - /** Portugal. */ - Pt = 'PT', - /** Qatar. */ - Qa = 'QA', - /** Cameroon. */ - Cm = 'CM', - /** Réunion. */ - Re = 'RE', - /** Romania. */ - Ro = 'RO', - /** Russia. */ - Ru = 'RU', - /** Rwanda. */ - Rw = 'RW', - /** St. Barthélemy. */ - Bl = 'BL', - /** St. Helena. */ - Sh = 'SH', - /** St. Kitts & Nevis. */ - Kn = 'KN', - /** St. Lucia. */ - Lc = 'LC', - /** St. Martin. */ - Mf = 'MF', - /** St. Pierre & Miquelon. */ - Pm = 'PM', - /** Samoa. */ - Ws = 'WS', - /** San Marino. */ - Sm = 'SM', - /** São Tomé & Príncipe. */ - St = 'ST', - /** Saudi Arabia. */ - Sa = 'SA', - /** Senegal. */ - Sn = 'SN', - /** Serbia. */ - Rs = 'RS', - /** Seychelles. */ - Sc = 'SC', - /** Sierra Leone. */ - Sl = 'SL', - /** Singapore. */ - Sg = 'SG', - /** Sint Maarten. */ - Sx = 'SX', - /** Slovakia. */ - Sk = 'SK', - /** Slovenia. */ - Si = 'SI', - /** Solomon Islands. */ - Sb = 'SB', - /** Somalia. */ - So = 'SO', - /** South Africa. */ - Za = 'ZA', - /** South Georgia & South Sandwich Islands. */ - Gs = 'GS', - /** South Korea. */ - Kr = 'KR', - /** South Sudan. */ - Ss = 'SS', - /** Spain. */ + Oz = 'OZ', + G = 'G', +} + +/** An enumeration. */ +export enum ShippingMethodTypeEnum { + Price = 'PRICE', + Weight = 'WEIGHT', +} + +export type ShippingMethodTranslation = Node & { + __typename?: 'ShippingMethodTranslation' + /** The ID of the object. */ + id: Scalars['ID'] + name?: Maybe + /** Translation language. */ + language: LanguageDisplay +} + +export type LanguageDisplay = { + __typename?: 'LanguageDisplay' + /** ISO 639 representation of the language name. */ + code: LanguageCodeEnum + /** Full name of the language. */ + language: Scalars['String'] +} + +/** An enumeration. */ +export enum LanguageCodeEnum { + Ar = 'AR', + Az = 'AZ', + Bg = 'BG', + Bn = 'BN', + Ca = 'CA', + Cs = 'CS', + Da = 'DA', + De = 'DE', + El = 'EL', + En = 'EN', Es = 'ES', - /** Sri Lanka. */ - Lk = 'LK', - /** St. Vincent & Grenadines. */ - Vc = 'VC', - /** Sudan. */ - Sd = 'SD', - /** Suriname. */ + EsCo = 'ES_CO', + Et = 'ET', + Fa = 'FA', + Fi = 'FI', + Fr = 'FR', + Hi = 'HI', + Hu = 'HU', + Hy = 'HY', + Id = 'ID', + Is = 'IS', + It = 'IT', + Ja = 'JA', + Ka = 'KA', + Km = 'KM', + Ko = 'KO', + Lt = 'LT', + Mn = 'MN', + My = 'MY', + Nb = 'NB', + Nl = 'NL', + Pl = 'PL', + Pt = 'PT', + PtBr = 'PT_BR', + Ro = 'RO', + Ru = 'RU', + Sk = 'SK', + Sl = 'SL', + Sq = 'SQ', Sr = 'SR', - /** Svalbard & Jan Mayen. */ - Sj = 'SJ', - /** Sweden. */ - Se = 'SE', - /** Switzerland. */ - Ch = 'CH', - /** Syria. */ - Sy = 'SY', - /** Taiwan. */ - Tw = 'TW', - /** Tajikistan. */ - Tj = 'TJ', - /** Tanzania. */ - Tz = 'TZ', - /** Thailand. */ + Sv = 'SV', + Sw = 'SW', + Ta = 'TA', Th = 'TH', - /** Timor-Leste. */ - Tl = 'TL', - /** Togo. */ - Tg = 'TG', - /** Tokelau. */ - Tk = 'TK', - /** Tonga. */ - To = 'TO', - /** Trinidad & Tobago. */ - Tt = 'TT', - /** Tunisia. */ - Tn = 'TN', - /** Turkey. */ Tr = 'TR', - /** Turkmenistan. */ + Uk = 'UK', + Vi = 'VI', + ZhHans = 'ZH_HANS', + ZhHant = 'ZH_HANT', +} + +/** Represents shipping method channel listing. */ +export type ShippingMethodChannelListing = Node & { + __typename?: 'ShippingMethodChannelListing' + /** The ID of the object. */ + id: Scalars['ID'] + channel: Channel + minimumOrderPrice?: Maybe + maximumOrderPrice?: Maybe + price?: Maybe +} + +/** Represents channel. */ +export type Channel = Node & { + __typename?: 'Channel' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + isActive: Scalars['Boolean'] + slug: Scalars['String'] + currencyCode: Scalars['String'] + /** Whether a channel has associated orders. */ + hasOrders: Scalars['Boolean'] + /** List of channel shipping zones. */ + shippingZones: Array +} + +/** Represents shipping method postal code rule. */ +export type ShippingMethodPostalCodeRule = Node & { + __typename?: 'ShippingMethodPostalCodeRule' + /** Start address range. */ + start?: Maybe + /** End address range. */ + end?: Maybe + /** Inclusion type of the postal code rule. */ + inclusionType?: Maybe + /** The ID of the object. */ + id: Scalars['ID'] +} + +/** An enumeration. */ +export enum PostalCodeRuleInclusionTypeEnum { + Include = 'INCLUDE', + Exclude = 'EXCLUDE', +} + +export type ProductCountableConnection = { + __typename?: 'ProductCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type ProductCountableEdge = { + __typename?: 'ProductCountableEdge' + /** The item at the end of the edge. */ + node: Product + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +/** Represents an individual item for sale in the storefront. */ +export type Product = Node & + ObjectWithMetadata & { + __typename?: 'Product' + /** The ID of the object. */ + id: Scalars['ID'] + seoTitle?: Maybe + seoDescription?: Maybe + name: Scalars['String'] + description?: Maybe + productType: ProductType + slug: Scalars['String'] + category?: Maybe + updatedAt?: Maybe + chargeTaxes: Scalars['Boolean'] + weight?: Maybe + defaultVariant?: Maybe + rating?: Maybe + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + /** + * Description of the product (JSON). + * @deprecated Will be removed in Saleor 4.0. Use the `description` field instead. + */ + descriptionJson?: Maybe + /** + * The storefront URL for the product. + * @deprecated This field will be removed after 2020-07-31. + */ + url: Scalars['String'] + /** The main thumbnail for a product. */ + thumbnail?: Maybe + /** Lists the storefront product's pricing, the current price and discounts, only meant for displaying. */ + pricing?: Maybe + /** Whether the product is in stock and visible or not. */ + isAvailable?: Maybe + /** A type of tax. Assigned by enabled tax gateway */ + taxType?: Maybe + /** List of attributes assigned to this product. */ + attributes: Array + /** List of availability in channels for the product. */ + channelListings?: Maybe> + /** Get a single product media by ID. */ + mediaById: ProductMedia + /** + * Get a single product image by ID. + * @deprecated Will be removed in Saleor 4.0. Use the `mediaById` field instead. + */ + imageById?: Maybe + /** List of variants for the product. */ + variants?: Maybe>> + /** List of media for the product. */ + media?: Maybe> + /** + * List of images for the product. + * @deprecated Will be removed in Saleor 4.0. Use the `media` field instead. + */ + images?: Maybe>> + /** List of collections for the product. */ + collections?: Maybe>> + /** Returns translated product fields for the given language code. */ + translation?: Maybe + /** Date when product is available for purchase. */ + availableForPurchase?: Maybe + /** Whether the product is available for purchase. */ + isAvailableForPurchase?: Maybe + } + +/** Represents an individual item for sale in the storefront. */ +export type ProductThumbnailArgs = { + size?: Maybe +} + +/** Represents an individual item for sale in the storefront. */ +export type ProductPricingArgs = { + address?: Maybe +} + +/** Represents an individual item for sale in the storefront. */ +export type ProductIsAvailableArgs = { + address?: Maybe +} + +/** Represents an individual item for sale in the storefront. */ +export type ProductMediaByIdArgs = { + id?: Maybe +} + +/** Represents an individual item for sale in the storefront. */ +export type ProductImageByIdArgs = { + id?: Maybe +} + +/** Represents an individual item for sale in the storefront. */ +export type ProductTranslationArgs = { + languageCode: LanguageCodeEnum +} + +/** Represents a type of product. It defines what attributes are available to products of this type. */ +export type ProductType = Node & + ObjectWithMetadata & { + __typename?: 'ProductType' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + slug: Scalars['String'] + hasVariants: Scalars['Boolean'] + isShippingRequired: Scalars['Boolean'] + isDigital: Scalars['Boolean'] + weight?: Maybe + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + /** + * List of products of this type. + * @deprecated Use the top-level `products` query with the `productTypes` filter. + */ + products?: Maybe + /** A type of tax. Assigned by enabled tax gateway */ + taxType?: Maybe + /** Variant attributes of that product type. */ + variantAttributes?: Maybe>> + /** Product attributes of that product type. */ + productAttributes?: Maybe>> + availableAttributes?: Maybe + } + +/** Represents a type of product. It defines what attributes are available to products of this type. */ +export type ProductTypeProductsArgs = { + channel?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +/** Represents a type of product. It defines what attributes are available to products of this type. */ +export type ProductTypeVariantAttributesArgs = { + variantSelection?: Maybe +} + +/** Represents a type of product. It defines what attributes are available to products of this type. */ +export type ProductTypeAvailableAttributesArgs = { + filter?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +/** Representation of tax types fetched from tax gateway. */ +export type TaxType = { + __typename?: 'TaxType' + /** Description of the tax type. */ + description?: Maybe + /** External tax code used to identify given tax group. */ + taxCode?: Maybe +} + +/** Custom attribute of a product. Attributes can be assigned to products and variants at the product type level. */ +export type Attribute = Node & + ObjectWithMetadata & { + __typename?: 'Attribute' + /** The ID of the object. */ + id: Scalars['ID'] + productTypes: ProductTypeCountableConnection + productVariantTypes: ProductTypeCountableConnection + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + /** The input type to use for entering attribute values in the dashboard. */ + inputType?: Maybe + /** The entity type which can be used as a reference. */ + entityType?: Maybe + /** Name of an attribute displayed in the interface. */ + name?: Maybe + /** Internal representation of an attribute name. */ + slug?: Maybe + /** The attribute type. */ + type?: Maybe + /** List of attribute's values. */ + values?: Maybe>> + /** Whether the attribute requires values to be passed or not. */ + valueRequired: Scalars['Boolean'] + /** Whether the attribute should be visible or not in storefront. */ + visibleInStorefront: Scalars['Boolean'] + /** Whether the attribute can be filtered in storefront. */ + filterableInStorefront: Scalars['Boolean'] + /** Whether the attribute can be filtered in dashboard. */ + filterableInDashboard: Scalars['Boolean'] + /** Whether the attribute can be displayed in the admin product list. */ + availableInGrid: Scalars['Boolean'] + /** Returns translated attribute fields for the given language code. */ + translation?: Maybe + /** The position of the attribute in the storefront navigation (0 by default). */ + storefrontSearchPosition: Scalars['Int'] + } + +/** Custom attribute of a product. Attributes can be assigned to products and variants at the product type level. */ +export type AttributeProductTypesArgs = { + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +/** Custom attribute of a product. Attributes can be assigned to products and variants at the product type level. */ +export type AttributeProductVariantTypesArgs = { + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +/** Custom attribute of a product. Attributes can be assigned to products and variants at the product type level. */ +export type AttributeTranslationArgs = { + languageCode: LanguageCodeEnum +} + +export type ProductTypeCountableConnection = { + __typename?: 'ProductTypeCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type ProductTypeCountableEdge = { + __typename?: 'ProductTypeCountableEdge' + /** The item at the end of the edge. */ + node: ProductType + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +/** An enumeration. */ +export enum AttributeInputTypeEnum { + Dropdown = 'DROPDOWN', + Multiselect = 'MULTISELECT', + File = 'FILE', + Reference = 'REFERENCE', + RichText = 'RICH_TEXT', +} + +/** An enumeration. */ +export enum AttributeEntityTypeEnum { + Page = 'PAGE', + Product = 'PRODUCT', +} + +/** An enumeration. */ +export enum AttributeTypeEnum { + ProductType = 'PRODUCT_TYPE', + PageType = 'PAGE_TYPE', +} + +/** Represents a value of an attribute. */ +export type AttributeValue = Node & { + __typename?: 'AttributeValue' + /** The ID of the object. */ + id: Scalars['ID'] + /** Name of a value displayed in the interface. */ + name?: Maybe + /** Internal representation of a value (unique per attribute). */ + slug?: Maybe + /** Represents the value of the attribute value. */ + value?: Maybe + /** Returns translated attribute value fields for the given language code. */ + translation?: Maybe + /** The input type to use for entering attribute values in the dashboard. */ + inputType?: Maybe + /** The ID of the attribute reference. */ + reference?: Maybe + /** Represents file URL and content type (if attribute value is a file). */ + file?: Maybe + /** Represents the text (JSON) of the attribute value. */ + richText?: Maybe +} + +/** Represents a value of an attribute. */ +export type AttributeValueTranslationArgs = { + languageCode: LanguageCodeEnum +} + +export type AttributeValueTranslation = Node & { + __typename?: 'AttributeValueTranslation' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + richText?: Maybe + /** Translation language. */ + language: LanguageDisplay +} + +export type File = { + __typename?: 'File' + /** The URL of the file. */ + url: Scalars['String'] + /** Content type of the file. */ + contentType?: Maybe +} + +export type AttributeTranslation = Node & { + __typename?: 'AttributeTranslation' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + /** Translation language. */ + language: LanguageDisplay +} + +export enum VariantAttributeScope { + All = 'ALL', + VariantSelection = 'VARIANT_SELECTION', + NotVariantSelection = 'NOT_VARIANT_SELECTION', +} + +export type AttributeCountableConnection = { + __typename?: 'AttributeCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type AttributeCountableEdge = { + __typename?: 'AttributeCountableEdge' + /** The item at the end of the edge. */ + node: Attribute + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type AttributeFilterInput = { + valueRequired?: Maybe + isVariantOnly?: Maybe + visibleInStorefront?: Maybe + filterableInStorefront?: Maybe + filterableInDashboard?: Maybe + availableInGrid?: Maybe + metadata?: Maybe>> + search?: Maybe + ids?: Maybe>> + type?: Maybe + inCollection?: Maybe + inCategory?: Maybe + /** Specifies the channel by which the data should be sorted. */ + channel?: Maybe +} + +export type MetadataInput = { + /** Key of a metadata item. */ + key: Scalars['String'] + /** Value of a metadata item. */ + value: Scalars['String'] +} + +/** Represents a single category of products. Categories allow to organize products in a tree-hierarchies which can be used for navigation in the storefront. */ +export type Category = Node & + ObjectWithMetadata & { + __typename?: 'Category' + seoTitle?: Maybe + seoDescription?: Maybe + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + description?: Maybe + slug: Scalars['String'] + parent?: Maybe + level: Scalars['Int'] + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + /** + * Description of the category (JSON). + * @deprecated Will be removed in Saleor 4.0. Use the `description` field instead. + */ + descriptionJson?: Maybe + /** List of ancestors of the category. */ + ancestors?: Maybe + /** List of products in the category. */ + products?: Maybe + /** + * The storefront's URL for the category. + * @deprecated This field will be removed after 2020-07-31. + */ + url?: Maybe + /** List of children of the category. */ + children?: Maybe + backgroundImage?: Maybe + /** Returns translated category fields for the given language code. */ + translation?: Maybe + } + +/** Represents a single category of products. Categories allow to organize products in a tree-hierarchies which can be used for navigation in the storefront. */ +export type CategoryAncestorsArgs = { + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +/** Represents a single category of products. Categories allow to organize products in a tree-hierarchies which can be used for navigation in the storefront. */ +export type CategoryProductsArgs = { + channel?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +/** Represents a single category of products. Categories allow to organize products in a tree-hierarchies which can be used for navigation in the storefront. */ +export type CategoryChildrenArgs = { + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +/** Represents a single category of products. Categories allow to organize products in a tree-hierarchies which can be used for navigation in the storefront. */ +export type CategoryBackgroundImageArgs = { + size?: Maybe +} + +/** Represents a single category of products. Categories allow to organize products in a tree-hierarchies which can be used for navigation in the storefront. */ +export type CategoryTranslationArgs = { + languageCode: LanguageCodeEnum +} + +export type CategoryCountableConnection = { + __typename?: 'CategoryCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type CategoryCountableEdge = { + __typename?: 'CategoryCountableEdge' + /** The item at the end of the edge. */ + node: Category + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +/** Represents an image. */ +export type Image = { + __typename?: 'Image' + /** The URL of the image. */ + url: Scalars['String'] + /** Alt text for an image. */ + alt?: Maybe +} + +export type CategoryTranslation = Node & { + __typename?: 'CategoryTranslation' + seoTitle?: Maybe + seoDescription?: Maybe + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + description?: Maybe + /** Translation language. */ + language: LanguageDisplay + /** + * Translated description of the product (JSON). + * @deprecated Will be removed in Saleor 4.0. Use the `description` field instead. + */ + descriptionJson?: Maybe +} + +/** Represents a version of a product such as different size or color. */ +export type ProductVariant = Node & + ObjectWithMetadata & { + __typename?: 'ProductVariant' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + sku: Scalars['String'] + product: Product + trackInventory: Scalars['Boolean'] + weight?: Maybe + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + /** List of price information in channels for the product. */ + channelListings?: Maybe> + /** Lists the storefront variant's pricing, the current price and discounts, only meant for displaying. */ + pricing?: Maybe + /** List of attributes assigned to this variant. */ + attributes: Array + /** Cost price of the variant. */ + costPrice?: Maybe + /** Gross margin percentage value. */ + margin?: Maybe + /** Total quantity ordered. */ + quantityOrdered?: Maybe + /** Total revenue generated by a variant in given period of time. Note: this field should be queried using `reportProductSales` query as it uses optimizations suitable for such calculations. */ + revenue?: Maybe + /** + * List of images for the product variant. + * @deprecated Will be removed in Saleor 4.0. Use the `media` instead. + */ + images?: Maybe>> + /** List of media for the product variant. */ + media?: Maybe> + /** Returns translated product variant fields for the given language code. */ + translation?: Maybe + /** Digital content for the product variant. */ + digitalContent?: Maybe + /** Stocks for the product variant. */ + stocks?: Maybe>> + /** Quantity of a product available for sale in one checkout. */ + quantityAvailable: Scalars['Int'] + } + +/** Represents a version of a product such as different size or color. */ +export type ProductVariantPricingArgs = { + address?: Maybe +} + +/** Represents a version of a product such as different size or color. */ +export type ProductVariantAttributesArgs = { + variantSelection?: Maybe +} + +/** Represents a version of a product such as different size or color. */ +export type ProductVariantRevenueArgs = { + period?: Maybe +} + +/** Represents a version of a product such as different size or color. */ +export type ProductVariantTranslationArgs = { + languageCode: LanguageCodeEnum +} + +/** Represents a version of a product such as different size or color. */ +export type ProductVariantStocksArgs = { + address?: Maybe + countryCode?: Maybe +} + +/** Represents a version of a product such as different size or color. */ +export type ProductVariantQuantityAvailableArgs = { + address?: Maybe + countryCode?: Maybe +} + +/** Represents product varaint channel listing. */ +export type ProductVariantChannelListing = Node & { + __typename?: 'ProductVariantChannelListing' + /** The ID of the object. */ + id: Scalars['ID'] + channel: Channel + price?: Maybe + /** Cost price of the variant. */ + costPrice?: Maybe + /** Gross margin percentage value. */ + margin?: Maybe +} + +/** Represents availability of a variant in the storefront. */ +export type VariantPricingInfo = { + __typename?: 'VariantPricingInfo' + /** Whether it is in sale or not. */ + onSale?: Maybe + /** The discount amount if in sale (null otherwise). */ + discount?: Maybe + /** The discount amount in the local currency. */ + discountLocalCurrency?: Maybe + /** The price, with any discount subtracted. */ + price?: Maybe + /** The price without any discount. */ + priceUndiscounted?: Maybe + /** The discounted price in the local currency. */ + priceLocalCurrency?: Maybe +} + +/** Represents a monetary value with taxes. In cases where taxes were not applied, net and gross values will be equal. */ +export type TaxedMoney = { + __typename?: 'TaxedMoney' + /** Currency code. */ + currency: Scalars['String'] + /** Amount of money including taxes. */ + gross: Money + /** Amount of money without taxes. */ + net: Money + /** Amount of taxes. */ + tax: Money +} + +export type AddressInput = { + /** Given name. */ + firstName?: Maybe + /** Family name. */ + lastName?: Maybe + /** Company or organization. */ + companyName?: Maybe + /** Address. */ + streetAddress1?: Maybe + /** Address. */ + streetAddress2?: Maybe + /** City. */ + city?: Maybe + /** District. */ + cityArea?: Maybe + /** Postal code. */ + postalCode?: Maybe + /** Country. */ + country?: Maybe + /** State or province. */ + countryArea?: Maybe + /** Phone number. */ + phone?: Maybe +} + +/** An enumeration. */ +export enum CountryCode { + Af = 'AF', + Ax = 'AX', + Al = 'AL', + Dz = 'DZ', + As = 'AS', + Ad = 'AD', + Ao = 'AO', + Ai = 'AI', + Aq = 'AQ', + Ag = 'AG', + Ar = 'AR', + Am = 'AM', + Aw = 'AW', + Au = 'AU', + At = 'AT', + Az = 'AZ', + Bs = 'BS', + Bh = 'BH', + Bd = 'BD', + Bb = 'BB', + By = 'BY', + Be = 'BE', + Bz = 'BZ', + Bj = 'BJ', + Bm = 'BM', + Bt = 'BT', + Bo = 'BO', + Bq = 'BQ', + Ba = 'BA', + Bw = 'BW', + Bv = 'BV', + Br = 'BR', + Io = 'IO', + Bn = 'BN', + Bg = 'BG', + Bf = 'BF', + Bi = 'BI', + Cv = 'CV', + Kh = 'KH', + Cm = 'CM', + Ca = 'CA', + Ky = 'KY', + Cf = 'CF', + Td = 'TD', + Cl = 'CL', + Cn = 'CN', + Cx = 'CX', + Cc = 'CC', + Co = 'CO', + Km = 'KM', + Cg = 'CG', + Cd = 'CD', + Ck = 'CK', + Cr = 'CR', + Ci = 'CI', + Hr = 'HR', + Cu = 'CU', + Cw = 'CW', + Cy = 'CY', + Cz = 'CZ', + Dk = 'DK', + Dj = 'DJ', + Dm = 'DM', + Do = 'DO', + Ec = 'EC', + Eg = 'EG', + Sv = 'SV', + Gq = 'GQ', + Er = 'ER', + Ee = 'EE', + Sz = 'SZ', + Et = 'ET', + Eu = 'EU', + Fk = 'FK', + Fo = 'FO', + Fj = 'FJ', + Fi = 'FI', + Fr = 'FR', + Gf = 'GF', + Pf = 'PF', + Tf = 'TF', + Ga = 'GA', + Gm = 'GM', + Ge = 'GE', + De = 'DE', + Gh = 'GH', + Gi = 'GI', + Gr = 'GR', + Gl = 'GL', + Gd = 'GD', + Gp = 'GP', + Gu = 'GU', + Gt = 'GT', + Gg = 'GG', + Gn = 'GN', + Gw = 'GW', + Gy = 'GY', + Ht = 'HT', + Hm = 'HM', + Va = 'VA', + Hn = 'HN', + Hk = 'HK', + Hu = 'HU', + Is = 'IS', + In = 'IN', + Id = 'ID', + Ir = 'IR', + Iq = 'IQ', + Ie = 'IE', + Im = 'IM', + Il = 'IL', + It = 'IT', + Jm = 'JM', + Jp = 'JP', + Je = 'JE', + Jo = 'JO', + Kz = 'KZ', + Ke = 'KE', + Ki = 'KI', + Kw = 'KW', + Kg = 'KG', + La = 'LA', + Lv = 'LV', + Lb = 'LB', + Ls = 'LS', + Lr = 'LR', + Ly = 'LY', + Li = 'LI', + Lt = 'LT', + Lu = 'LU', + Mo = 'MO', + Mg = 'MG', + Mw = 'MW', + My = 'MY', + Mv = 'MV', + Ml = 'ML', + Mt = 'MT', + Mh = 'MH', + Mq = 'MQ', + Mr = 'MR', + Mu = 'MU', + Yt = 'YT', + Mx = 'MX', + Fm = 'FM', + Md = 'MD', + Mc = 'MC', + Mn = 'MN', + Me = 'ME', + Ms = 'MS', + Ma = 'MA', + Mz = 'MZ', + Mm = 'MM', + Na = 'NA', + Nr = 'NR', + Np = 'NP', + Nl = 'NL', + Nc = 'NC', + Nz = 'NZ', + Ni = 'NI', + Ne = 'NE', + Ng = 'NG', + Nu = 'NU', + Nf = 'NF', + Kp = 'KP', + Mk = 'MK', + Mp = 'MP', + No = 'NO', + Om = 'OM', + Pk = 'PK', + Pw = 'PW', + Ps = 'PS', + Pa = 'PA', + Pg = 'PG', + Py = 'PY', + Pe = 'PE', + Ph = 'PH', + Pn = 'PN', + Pl = 'PL', + Pt = 'PT', + Pr = 'PR', + Qa = 'QA', + Re = 'RE', + Ro = 'RO', + Ru = 'RU', + Rw = 'RW', + Bl = 'BL', + Sh = 'SH', + Kn = 'KN', + Lc = 'LC', + Mf = 'MF', + Pm = 'PM', + Vc = 'VC', + Ws = 'WS', + Sm = 'SM', + St = 'ST', + Sa = 'SA', + Sn = 'SN', + Rs = 'RS', + Sc = 'SC', + Sl = 'SL', + Sg = 'SG', + Sx = 'SX', + Sk = 'SK', + Si = 'SI', + Sb = 'SB', + So = 'SO', + Za = 'ZA', + Gs = 'GS', + Kr = 'KR', + Ss = 'SS', + Es = 'ES', + Lk = 'LK', + Sd = 'SD', + Sr = 'SR', + Sj = 'SJ', + Se = 'SE', + Ch = 'CH', + Sy = 'SY', + Tw = 'TW', + Tj = 'TJ', + Tz = 'TZ', + Th = 'TH', + Tl = 'TL', + Tg = 'TG', + Tk = 'TK', + To = 'TO', + Tt = 'TT', + Tn = 'TN', + Tr = 'TR', Tm = 'TM', - /** Turks & Caicos Islands. */ Tc = 'TC', - /** Tuvalu. */ Tv = 'TV', - /** Uganda. */ Ug = 'UG', - /** Ukraine. */ Ua = 'UA', - /** United Arab Emirates. */ Ae = 'AE', - /** United Kingdom. */ Gb = 'GB', - /** United States. */ - Us = 'US', - /** U.S. Outlying Islands. */ Um = 'UM', - /** Uruguay. */ + Us = 'US', Uy = 'UY', - /** Uzbekistan. */ Uz = 'UZ', - /** Vanuatu. */ Vu = 'VU', - /** Venezuela. */ Ve = 'VE', - /** Vietnam. */ Vn = 'VN', - /** British Virgin Islands. */ Vg = 'VG', - /** Wallis & Futuna. */ + Vi = 'VI', Wf = 'WF', - /** Western Sahara. */ Eh = 'EH', - /** Yemen. */ Ye = 'YE', - /** Zambia. */ Zm = 'ZM', - /** Zimbabwe. */ Zw = 'ZW', } -/** Credit card information used for a payment. */ -export type CreditCard = { - __typename?: 'CreditCard' - /** The brand of the credit card. */ - brand?: Maybe - /** The expiry month of the credit card. */ - expiryMonth?: Maybe - /** The expiry year of the credit card. */ - expiryYear?: Maybe - /** The credit card's BIN number. */ - firstDigits?: Maybe - /** The first name of the card holder. */ - firstName?: Maybe - /** The last 4 digits of the credit card. */ - lastDigits?: Maybe - /** The last name of the card holder. */ - lastName?: Maybe - /** The masked credit card number with only the last 4 digits displayed. */ - maskedNumber?: Maybe +/** Represents a custom attribute. */ +export type SelectedAttribute = { + __typename?: 'SelectedAttribute' + /** Name of an attribute displayed in the interface. */ + attribute: Attribute + /** Values of an attribute. */ + values: Array> } -/** - * Specifies the fields required to complete a checkout with - * a Shopify vaulted credit card payment. - */ -export type CreditCardPaymentInput = { - /** The amount of the payment. */ - amount: Scalars['Money'] - /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. */ - idempotencyKey: Scalars['String'] - /** The billing address for the payment. */ - billingAddress: MailingAddressInput - /** The ID returned by Shopify's Card Vault. */ - vaultId: Scalars['String'] - /** Executes the payment in test mode if possible. Defaults to `false`. */ - test?: Maybe +export enum ReportingPeriod { + Today = 'TODAY', + ThisMonth = 'THIS_MONTH', } -/** - * Specifies the fields required to complete a checkout with - * a Shopify vaulted credit card payment. - */ -export type CreditCardPaymentInputV2 = { - /** The amount and currency of the payment. */ - paymentAmount: MoneyInput - /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. */ - idempotencyKey: Scalars['String'] - /** The billing address for the payment. */ - billingAddress: MailingAddressInput - /** The ID returned by Shopify's Card Vault. */ - vaultId: Scalars['String'] - /** Executes the payment in test mode if possible. Defaults to `false`. */ - test?: Maybe -} - -/** The part of the image that should remain after cropping. */ -export enum CropRegion { - /** Keep the center of the image. */ - Center = 'CENTER', - /** Keep the top of the image. */ - Top = 'TOP', - /** Keep the bottom of the image. */ - Bottom = 'BOTTOM', - /** Keep the left of the image. */ - Left = 'LEFT', - /** Keep the right of the image. */ - Right = 'RIGHT', -} - -/** Currency codes. */ -export enum CurrencyCode { - /** United States Dollars (USD). */ - Usd = 'USD', - /** Euro (EUR). */ - Eur = 'EUR', - /** United Kingdom Pounds (GBP). */ - Gbp = 'GBP', - /** Canadian Dollars (CAD). */ - Cad = 'CAD', - /** Afghan Afghani (AFN). */ - Afn = 'AFN', - /** Albanian Lek (ALL). */ - All = 'ALL', - /** Algerian Dinar (DZD). */ - Dzd = 'DZD', - /** Angolan Kwanza (AOA). */ - Aoa = 'AOA', - /** Argentine Pesos (ARS). */ - Ars = 'ARS', - /** Armenian Dram (AMD). */ - Amd = 'AMD', - /** Aruban Florin (AWG). */ - Awg = 'AWG', - /** Australian Dollars (AUD). */ - Aud = 'AUD', - /** Barbadian Dollar (BBD). */ - Bbd = 'BBD', - /** Azerbaijani Manat (AZN). */ - Azn = 'AZN', - /** Bangladesh Taka (BDT). */ - Bdt = 'BDT', - /** Bahamian Dollar (BSD). */ - Bsd = 'BSD', - /** Bahraini Dinar (BHD). */ - Bhd = 'BHD', - /** Burundian Franc (BIF). */ - Bif = 'BIF', - /** Belarusian Ruble (BYN). */ - Byn = 'BYN', - /** Belarusian Ruble (BYR). */ - Byr = 'BYR', - /** Belize Dollar (BZD). */ - Bzd = 'BZD', - /** Bermudian Dollar (BMD). */ - Bmd = 'BMD', - /** Bhutanese Ngultrum (BTN). */ - Btn = 'BTN', - /** Bosnia and Herzegovina Convertible Mark (BAM). */ - Bam = 'BAM', - /** Brazilian Real (BRL). */ - Brl = 'BRL', - /** Bolivian Boliviano (BOB). */ - Bob = 'BOB', - /** Botswana Pula (BWP). */ - Bwp = 'BWP', - /** Brunei Dollar (BND). */ - Bnd = 'BND', - /** Bulgarian Lev (BGN). */ - Bgn = 'BGN', - /** Burmese Kyat (MMK). */ - Mmk = 'MMK', - /** Cambodian Riel. */ - Khr = 'KHR', - /** Cape Verdean escudo (CVE). */ - Cve = 'CVE', - /** Cayman Dollars (KYD). */ - Kyd = 'KYD', - /** Central African CFA Franc (XAF). */ - Xaf = 'XAF', - /** Chilean Peso (CLP). */ - Clp = 'CLP', - /** Chinese Yuan Renminbi (CNY). */ - Cny = 'CNY', - /** Colombian Peso (COP). */ - Cop = 'COP', - /** Comorian Franc (KMF). */ - Kmf = 'KMF', - /** Congolese franc (CDF). */ - Cdf = 'CDF', - /** Costa Rican Colones (CRC). */ - Crc = 'CRC', - /** Croatian Kuna (HRK). */ - Hrk = 'HRK', - /** Czech Koruny (CZK). */ - Czk = 'CZK', - /** Danish Kroner (DKK). */ - Dkk = 'DKK', - /** Djiboutian Franc (DJF). */ - Djf = 'DJF', - /** Dominican Peso (DOP). */ - Dop = 'DOP', - /** East Caribbean Dollar (XCD). */ - Xcd = 'XCD', - /** Egyptian Pound (EGP). */ - Egp = 'EGP', - /** Eritrean Nakfa (ERN). */ - Ern = 'ERN', - /** Ethiopian Birr (ETB). */ - Etb = 'ETB', - /** Falkland Islands Pounds (FKP). */ - Fkp = 'FKP', - /** CFP Franc (XPF). */ - Xpf = 'XPF', - /** Fijian Dollars (FJD). */ - Fjd = 'FJD', - /** Gibraltar Pounds (GIP). */ - Gip = 'GIP', - /** Gambian Dalasi (GMD). */ - Gmd = 'GMD', - /** Ghanaian Cedi (GHS). */ - Ghs = 'GHS', - /** Guatemalan Quetzal (GTQ). */ - Gtq = 'GTQ', - /** Guyanese Dollar (GYD). */ - Gyd = 'GYD', - /** Georgian Lari (GEL). */ - Gel = 'GEL', - /** Guinean Franc (GNF). */ - Gnf = 'GNF', - /** Haitian Gourde (HTG). */ - Htg = 'HTG', - /** Honduran Lempira (HNL). */ - Hnl = 'HNL', - /** Hong Kong Dollars (HKD). */ - Hkd = 'HKD', - /** Hungarian Forint (HUF). */ - Huf = 'HUF', - /** Icelandic Kronur (ISK). */ - Isk = 'ISK', - /** Indian Rupees (INR). */ - Inr = 'INR', - /** Indonesian Rupiah (IDR). */ - Idr = 'IDR', - /** Israeli New Shekel (NIS). */ - Ils = 'ILS', - /** Iranian Rial (IRR). */ - Irr = 'IRR', - /** Iraqi Dinar (IQD). */ - Iqd = 'IQD', - /** Jamaican Dollars (JMD). */ - Jmd = 'JMD', - /** Japanese Yen (JPY). */ - Jpy = 'JPY', - /** Jersey Pound. */ - Jep = 'JEP', - /** Jordanian Dinar (JOD). */ - Jod = 'JOD', - /** Kazakhstani Tenge (KZT). */ - Kzt = 'KZT', - /** Kenyan Shilling (KES). */ - Kes = 'KES', - /** Kiribati Dollar (KID). */ - Kid = 'KID', - /** Kuwaiti Dinar (KWD). */ - Kwd = 'KWD', - /** Kyrgyzstani Som (KGS). */ - Kgs = 'KGS', - /** Laotian Kip (LAK). */ - Lak = 'LAK', - /** Latvian Lati (LVL). */ - Lvl = 'LVL', - /** Lebanese Pounds (LBP). */ - Lbp = 'LBP', - /** Lesotho Loti (LSL). */ - Lsl = 'LSL', - /** Liberian Dollar (LRD). */ - Lrd = 'LRD', - /** Libyan Dinar (LYD). */ - Lyd = 'LYD', - /** Lithuanian Litai (LTL). */ - Ltl = 'LTL', - /** Malagasy Ariary (MGA). */ - Mga = 'MGA', - /** Macedonia Denar (MKD). */ - Mkd = 'MKD', - /** Macanese Pataca (MOP). */ - Mop = 'MOP', - /** Malawian Kwacha (MWK). */ - Mwk = 'MWK', - /** Maldivian Rufiyaa (MVR). */ - Mvr = 'MVR', - /** Mauritanian Ouguiya (MRU). */ - Mru = 'MRU', - /** Mexican Pesos (MXN). */ - Mxn = 'MXN', - /** Malaysian Ringgits (MYR). */ - Myr = 'MYR', - /** Mauritian Rupee (MUR). */ - Mur = 'MUR', - /** Moldovan Leu (MDL). */ - Mdl = 'MDL', - /** Moroccan Dirham. */ - Mad = 'MAD', - /** Mongolian Tugrik. */ - Mnt = 'MNT', - /** Mozambican Metical. */ - Mzn = 'MZN', - /** Namibian Dollar. */ - Nad = 'NAD', - /** Nepalese Rupee (NPR). */ - Npr = 'NPR', - /** Netherlands Antillean Guilder. */ - Ang = 'ANG', - /** New Zealand Dollars (NZD). */ - Nzd = 'NZD', - /** Nicaraguan Córdoba (NIO). */ - Nio = 'NIO', - /** Nigerian Naira (NGN). */ - Ngn = 'NGN', - /** Norwegian Kroner (NOK). */ - Nok = 'NOK', - /** Omani Rial (OMR). */ - Omr = 'OMR', - /** Panamian Balboa (PAB). */ - Pab = 'PAB', - /** Pakistani Rupee (PKR). */ - Pkr = 'PKR', - /** Papua New Guinean Kina (PGK). */ - Pgk = 'PGK', - /** Paraguayan Guarani (PYG). */ - Pyg = 'PYG', - /** Peruvian Nuevo Sol (PEN). */ - Pen = 'PEN', - /** Philippine Peso (PHP). */ - Php = 'PHP', - /** Polish Zlotych (PLN). */ - Pln = 'PLN', - /** Qatari Rial (QAR). */ - Qar = 'QAR', - /** Romanian Lei (RON). */ - Ron = 'RON', - /** Russian Rubles (RUB). */ - Rub = 'RUB', - /** Rwandan Franc (RWF). */ - Rwf = 'RWF', - /** Samoan Tala (WST). */ - Wst = 'WST', - /** Saint Helena Pounds (SHP). */ - Shp = 'SHP', - /** Saudi Riyal (SAR). */ - Sar = 'SAR', - /** Sao Tome And Principe Dobra (STD). */ - Std = 'STD', - /** Serbian dinar (RSD). */ - Rsd = 'RSD', - /** Seychellois Rupee (SCR). */ - Scr = 'SCR', - /** Sierra Leonean Leone (SLL). */ - Sll = 'SLL', - /** Singapore Dollars (SGD). */ - Sgd = 'SGD', - /** Sudanese Pound (SDG). */ - Sdg = 'SDG', - /** Somali Shilling (SOS). */ - Sos = 'SOS', - /** Syrian Pound (SYP). */ - Syp = 'SYP', - /** South African Rand (ZAR). */ - Zar = 'ZAR', - /** South Korean Won (KRW). */ - Krw = 'KRW', - /** South Sudanese Pound (SSP). */ - Ssp = 'SSP', - /** Solomon Islands Dollar (SBD). */ - Sbd = 'SBD', - /** Sri Lankan Rupees (LKR). */ - Lkr = 'LKR', - /** Surinamese Dollar (SRD). */ - Srd = 'SRD', - /** Swazi Lilangeni (SZL). */ - Szl = 'SZL', - /** Swedish Kronor (SEK). */ - Sek = 'SEK', - /** Swiss Francs (CHF). */ - Chf = 'CHF', - /** Taiwan Dollars (TWD). */ - Twd = 'TWD', - /** Thai baht (THB). */ - Thb = 'THB', - /** Tajikistani Somoni (TJS). */ - Tjs = 'TJS', - /** Tanzanian Shilling (TZS). */ - Tzs = 'TZS', - /** Tongan Pa'anga (TOP). */ - Top = 'TOP', - /** Trinidad and Tobago Dollars (TTD). */ - Ttd = 'TTD', - /** Tunisian Dinar (TND). */ - Tnd = 'TND', - /** Turkish Lira (TRY). */ - Try = 'TRY', - /** Turkmenistani Manat (TMT). */ - Tmt = 'TMT', - /** Ugandan Shilling (UGX). */ - Ugx = 'UGX', - /** Ukrainian Hryvnia (UAH). */ - Uah = 'UAH', - /** United Arab Emirates Dirham (AED). */ - Aed = 'AED', - /** Uruguayan Pesos (UYU). */ - Uyu = 'UYU', - /** Uzbekistan som (UZS). */ - Uzs = 'UZS', - /** Vanuatu Vatu (VUV). */ - Vuv = 'VUV', - /** Venezuelan Bolivares (VEF). */ - Vef = 'VEF', - /** Venezuelan Bolivares (VES). */ - Ves = 'VES', - /** Vietnamese đồng (VND). */ - Vnd = 'VND', - /** West African CFA franc (XOF). */ - Xof = 'XOF', - /** Yemeni Rial (YER). */ - Yer = 'YER', - /** Zambian Kwacha (ZMW). */ - Zmw = 'ZMW', -} - -/** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ -export type Customer = { - __typename?: 'Customer' - /** Indicates whether the customer has consented to be sent marketing material via email. */ - acceptsMarketing: Scalars['Boolean'] - /** A list of addresses for the customer. */ - addresses: MailingAddressConnection - /** The date and time when the customer was created. */ - createdAt: Scalars['DateTime'] - /** The customer’s default address. */ - defaultAddress?: Maybe - /** The customer’s name, email or phone number. */ - displayName: Scalars['String'] - /** The customer’s email address. */ - email?: Maybe - /** The customer’s first name. */ - firstName?: Maybe - /** A unique identifier for the customer. */ +/** Represents a product image. */ +export type ProductImage = { + __typename?: 'ProductImage' + /** The ID of the image. */ id: Scalars['ID'] - /** The customer's most recently updated, incomplete checkout. */ - lastIncompleteCheckout?: Maybe - /** The customer’s last name. */ - lastName?: Maybe - /** The orders associated with the customer. */ - orders: OrderConnection - /** The customer’s phone number. */ - phone?: Maybe - /** - * A comma separated list of tags that have been added to the customer. - * Additional access scope required: unauthenticated_read_customer_tags. - */ - tags: Array - /** The date and time when the customer information was updated. */ - updatedAt: Scalars['DateTime'] -} - -/** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ -export type CustomerAddressesArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe -} - -/** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ -export type CustomerOrdersArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe -} - -/** A CustomerAccessToken represents the unique token required to make modifications to the customer object. */ -export type CustomerAccessToken = { - __typename?: 'CustomerAccessToken' - /** The customer’s access token. */ - accessToken: Scalars['String'] - /** The date and time when the customer access token expires. */ - expiresAt: Scalars['DateTime'] -} - -/** Specifies the input fields required to create a customer access token. */ -export type CustomerAccessTokenCreateInput = { - /** The email associated to the customer. */ - email: Scalars['String'] - /** The login password to be used by the customer. */ - password: Scalars['String'] -} - -/** Return type for `customerAccessTokenCreate` mutation. */ -export type CustomerAccessTokenCreatePayload = { - __typename?: 'CustomerAccessTokenCreatePayload' - /** The newly created customer access token object. */ - customerAccessToken?: Maybe - /** List of errors that occurred executing the mutation. */ - customerUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `customerAccessTokenCreateWithMultipass` mutation. */ -export type CustomerAccessTokenCreateWithMultipassPayload = { - __typename?: 'CustomerAccessTokenCreateWithMultipassPayload' - /** An access token object associated with the customer. */ - customerAccessToken?: Maybe - /** List of errors that occurred executing the mutation. */ - customerUserErrors: Array -} - -/** Return type for `customerAccessTokenDelete` mutation. */ -export type CustomerAccessTokenDeletePayload = { - __typename?: 'CustomerAccessTokenDeletePayload' - /** The destroyed access token. */ - deletedAccessToken?: Maybe - /** ID of the destroyed customer access token. */ - deletedCustomerAccessTokenId?: Maybe - /** List of errors that occurred executing the mutation. */ - userErrors: Array -} - -/** Return type for `customerAccessTokenRenew` mutation. */ -export type CustomerAccessTokenRenewPayload = { - __typename?: 'CustomerAccessTokenRenewPayload' - /** The renewed customer access token object. */ - customerAccessToken?: Maybe - /** List of errors that occurred executing the mutation. */ - userErrors: Array -} - -/** Return type for `customerActivateByUrl` mutation. */ -export type CustomerActivateByUrlPayload = { - __typename?: 'CustomerActivateByUrlPayload' - /** The customer that was activated. */ - customer?: Maybe - /** A new customer access token for the customer. */ - customerAccessToken?: Maybe - /** List of errors that occurred executing the mutation. */ - customerUserErrors: Array -} - -/** Specifies the input fields required to activate a customer. */ -export type CustomerActivateInput = { - /** The activation token required to activate the customer. */ - activationToken: Scalars['String'] - /** New password that will be set during activation. */ - password: Scalars['String'] -} - -/** Return type for `customerActivate` mutation. */ -export type CustomerActivatePayload = { - __typename?: 'CustomerActivatePayload' - /** The customer object. */ - customer?: Maybe - /** A newly created customer access token object for the customer. */ - customerAccessToken?: Maybe - /** List of errors that occurred executing the mutation. */ - customerUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `customerAddressCreate` mutation. */ -export type CustomerAddressCreatePayload = { - __typename?: 'CustomerAddressCreatePayload' - /** The new customer address object. */ - customerAddress?: Maybe - /** List of errors that occurred executing the mutation. */ - customerUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `customerAddressDelete` mutation. */ -export type CustomerAddressDeletePayload = { - __typename?: 'CustomerAddressDeletePayload' - /** List of errors that occurred executing the mutation. */ - customerUserErrors: Array - /** ID of the deleted customer address. */ - deletedCustomerAddressId?: Maybe - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `customerAddressUpdate` mutation. */ -export type CustomerAddressUpdatePayload = { - __typename?: 'CustomerAddressUpdatePayload' - /** The customer’s updated mailing address. */ - customerAddress?: Maybe - /** List of errors that occurred executing the mutation. */ - customerUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead - */ - userErrors: Array -} - -/** Specifies the fields required to create a new customer. */ -export type CustomerCreateInput = { - /** The customer’s first name. */ - firstName?: Maybe - /** The customer’s last name. */ - lastName?: Maybe - /** The customer’s email. */ - email: Scalars['String'] - /** - * A unique phone number for the customer. - * - * Formatted using E.164 standard. For example, _+16135551111_. - */ - phone?: Maybe - /** The login password used by the customer. */ - password: Scalars['String'] - /** Indicates whether the customer has consented to be sent marketing material via email. */ - acceptsMarketing?: Maybe -} - -/** Return type for `customerCreate` mutation. */ -export type CustomerCreatePayload = { - __typename?: 'CustomerCreatePayload' - /** The created customer object. */ - customer?: Maybe - /** List of errors that occurred executing the mutation. */ - customerUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `customerDefaultAddressUpdate` mutation. */ -export type CustomerDefaultAddressUpdatePayload = { - __typename?: 'CustomerDefaultAddressUpdatePayload' - /** The updated customer object. */ - customer?: Maybe - /** List of errors that occurred executing the mutation. */ - customerUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead - */ - userErrors: Array -} - -/** Possible error codes that could be returned by CustomerUserError. */ -export enum CustomerErrorCode { - /** Input value is blank. */ - Blank = 'BLANK', - /** Input value is invalid. */ - Invalid = 'INVALID', - /** Input value is already taken. */ - Taken = 'TAKEN', - /** Input value is too long. */ - TooLong = 'TOO_LONG', - /** Input value is too short. */ - TooShort = 'TOO_SHORT', - /** Unidentified customer. */ - UnidentifiedCustomer = 'UNIDENTIFIED_CUSTOMER', - /** Customer is disabled. */ - CustomerDisabled = 'CUSTOMER_DISABLED', - /** Input password starts or ends with whitespace. */ - PasswordStartsOrEndsWithWhitespace = 'PASSWORD_STARTS_OR_ENDS_WITH_WHITESPACE', - /** Input contains HTML tags. */ - ContainsHtmlTags = 'CONTAINS_HTML_TAGS', - /** Input contains URL. */ - ContainsUrl = 'CONTAINS_URL', - /** Invalid activation token. */ - TokenInvalid = 'TOKEN_INVALID', - /** Customer already enabled. */ - AlreadyEnabled = 'ALREADY_ENABLED', - /** Address does not exist. */ - NotFound = 'NOT_FOUND', - /** Input email contains an invalid domain name. */ - BadDomain = 'BAD_DOMAIN', - /** Multipass token is not valid. */ - InvalidMultipassRequest = 'INVALID_MULTIPASS_REQUEST', -} - -/** Return type for `customerRecover` mutation. */ -export type CustomerRecoverPayload = { - __typename?: 'CustomerRecoverPayload' - /** List of errors that occurred executing the mutation. */ - customerUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead - */ - userErrors: Array -} - -/** Return type for `customerResetByUrl` mutation. */ -export type CustomerResetByUrlPayload = { - __typename?: 'CustomerResetByUrlPayload' - /** The customer object which was reset. */ - customer?: Maybe - /** A newly created customer access token object for the customer. */ - customerAccessToken?: Maybe - /** List of errors that occurred executing the mutation. */ - customerUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead - */ - userErrors: Array -} - -/** Specifies the fields required to reset a customer’s password. */ -export type CustomerResetInput = { - /** The reset token required to reset the customer’s password. */ - resetToken: Scalars['String'] - /** New password that will be set as part of the reset password process. */ - password: Scalars['String'] -} - -/** Return type for `customerReset` mutation. */ -export type CustomerResetPayload = { - __typename?: 'CustomerResetPayload' - /** The customer object which was reset. */ - customer?: Maybe - /** A newly created customer access token object for the customer. */ - customerAccessToken?: Maybe - /** List of errors that occurred executing the mutation. */ - customerUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead - */ - userErrors: Array -} - -/** Specifies the fields required to update the Customer information. */ -export type CustomerUpdateInput = { - /** The customer’s first name. */ - firstName?: Maybe - /** The customer’s last name. */ - lastName?: Maybe - /** The customer’s email. */ - email?: Maybe - /** - * A unique phone number for the customer. - * - * Formatted using E.164 standard. For example, _+16135551111_. To remove the phone number, specify `null`. - */ - phone?: Maybe - /** The login password used by the customer. */ - password?: Maybe - /** Indicates whether the customer has consented to be sent marketing material via email. */ - acceptsMarketing?: Maybe -} - -/** Return type for `customerUpdate` mutation. */ -export type CustomerUpdatePayload = { - __typename?: 'CustomerUpdatePayload' - /** The updated customer object. */ - customer?: Maybe - /** - * The newly created customer access token. If the customer's password is updated, all previous access tokens - * (including the one used to perform this mutation) become invalid, and a new token is generated. - */ - customerAccessToken?: Maybe - /** List of errors that occurred executing the mutation. */ - customerUserErrors: Array - /** - * List of errors that occurred executing the mutation. - * @deprecated Use `customerUserErrors` instead - */ - userErrors: Array -} - -/** Represents an error that happens during execution of a customer mutation. */ -export type CustomerUserError = DisplayableError & { - __typename?: 'CustomerUserError' - /** Error code to uniquely identify the error. */ - code?: Maybe - /** Path to the input field which caused the error. */ - field?: Maybe> - /** The error message. */ - message: Scalars['String'] -} - -/** Digital wallet, such as Apple Pay, which can be used for accelerated checkouts. */ -export enum DigitalWallet { - /** Apple Pay. */ - ApplePay = 'APPLE_PAY', - /** Android Pay. */ - AndroidPay = 'ANDROID_PAY', - /** Google Pay. */ - GooglePay = 'GOOGLE_PAY', - /** Shopify Pay. */ - ShopifyPay = 'SHOPIFY_PAY', -} - -/** An amount discounting the line that has been allocated by a discount. */ -export type DiscountAllocation = { - __typename?: 'DiscountAllocation' - /** Amount of discount allocated. */ - allocatedAmount: MoneyV2 - /** The discount this allocated amount originated from. */ - discountApplication: DiscountApplication -} - -/** - * Discount applications capture the intentions of a discount source at - * the time of application. - */ -export type DiscountApplication = { - /** The method by which the discount's value is allocated to its entitled items. */ - allocationMethod: DiscountApplicationAllocationMethod - /** Which lines of targetType that the discount is allocated over. */ - targetSelection: DiscountApplicationTargetSelection - /** The type of line that the discount is applicable towards. */ - targetType: DiscountApplicationTargetType - /** The value of the discount application. */ - value: PricingValue -} - -/** The method by which the discount's value is allocated onto its entitled lines. */ -export enum DiscountApplicationAllocationMethod { - /** The value is spread across all entitled lines. */ - Across = 'ACROSS', - /** The value is applied onto every entitled line. */ - Each = 'EACH', - /** The value is specifically applied onto a particular line. */ - One = 'ONE', -} - -/** An auto-generated type for paginating through multiple DiscountApplications. */ -export type DiscountApplicationConnection = { - __typename?: 'DiscountApplicationConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** An auto-generated type which holds one DiscountApplication and a cursor during pagination. */ -export type DiscountApplicationEdge = { - __typename?: 'DiscountApplicationEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of DiscountApplicationEdge. */ - node: DiscountApplication -} - -/** - * Which lines on the order that the discount is allocated over, of the type - * defined by the Discount Application's target_type. - */ -export enum DiscountApplicationTargetSelection { - /** The discount is allocated onto all the lines. */ - All = 'ALL', - /** The discount is allocated onto only the lines it is entitled for. */ - Entitled = 'ENTITLED', - /** The discount is allocated onto explicitly chosen lines. */ - Explicit = 'EXPLICIT', -} - -/** The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards. */ -export enum DiscountApplicationTargetType { - /** The discount applies onto line items. */ - LineItem = 'LINE_ITEM', - /** The discount applies onto shipping lines. */ - ShippingLine = 'SHIPPING_LINE', -} - -/** - * Discount code applications capture the intentions of a discount code at - * the time that it is applied. - */ -export type DiscountCodeApplication = DiscountApplication & { - __typename?: 'DiscountCodeApplication' - /** The method by which the discount's value is allocated to its entitled items. */ - allocationMethod: DiscountApplicationAllocationMethod - /** Specifies whether the discount code was applied successfully. */ - applicable: Scalars['Boolean'] - /** The string identifying the discount code that was used at the time of application. */ - code: Scalars['String'] - /** Which lines of targetType that the discount is allocated over. */ - targetSelection: DiscountApplicationTargetSelection - /** The type of line that the discount is applicable towards. */ - targetType: DiscountApplicationTargetType - /** The value of the discount application. */ - value: PricingValue -} - -/** Represents an error in the input of a mutation. */ -export type DisplayableError = { - /** Path to the input field which caused the error. */ - field?: Maybe> - /** The error message. */ - message: Scalars['String'] -} - -/** Represents a web address. */ -export type Domain = { - __typename?: 'Domain' - /** The host name of the domain (eg: `example.com`). */ - host: Scalars['String'] - /** Whether SSL is enabled or not. */ - sslEnabled: Scalars['Boolean'] - /** The URL of the domain (eg: `https://example.com`). */ - url: Scalars['URL'] -} - -/** Represents a video hosted outside of Shopify. */ -export type ExternalVideo = Node & - Media & { - __typename?: 'ExternalVideo' - /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe - /** The URL. */ - embeddedUrl: Scalars['URL'] - /** Globally unique identifier. */ - id: Scalars['ID'] - /** The media content type. */ - mediaContentType: MediaContentType - /** The preview image for the media. */ - previewImage?: Maybe - } - -/** Represents a single fulfillment in an order. */ -export type Fulfillment = { - __typename?: 'Fulfillment' - /** List of the fulfillment's line items. */ - fulfillmentLineItems: FulfillmentLineItemConnection - /** The name of the tracking company. */ - trackingCompany?: Maybe - /** - * Tracking information associated with the fulfillment, - * such as the tracking number and tracking URL. - */ - trackingInfo: Array -} - -/** Represents a single fulfillment in an order. */ -export type FulfillmentFulfillmentLineItemsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe -} - -/** Represents a single fulfillment in an order. */ -export type FulfillmentTrackingInfoArgs = { - first?: Maybe -} - -/** Represents a single line item in a fulfillment. There is at most one fulfillment line item for each order line item. */ -export type FulfillmentLineItem = { - __typename?: 'FulfillmentLineItem' - /** The associated order's line item. */ - lineItem: OrderLineItem - /** The amount fulfilled in this fulfillment. */ - quantity: Scalars['Int'] -} - -/** An auto-generated type for paginating through multiple FulfillmentLineItems. */ -export type FulfillmentLineItemConnection = { - __typename?: 'FulfillmentLineItemConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination. */ -export type FulfillmentLineItemEdge = { - __typename?: 'FulfillmentLineItemEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of FulfillmentLineItemEdge. */ - node: FulfillmentLineItem -} - -/** Tracking information associated with the fulfillment. */ -export type FulfillmentTrackingInfo = { - __typename?: 'FulfillmentTrackingInfo' - /** The tracking number of the fulfillment. */ - number?: Maybe - /** The URL to track the fulfillment. */ - url?: Maybe -} - -/** Represents information about the metafields associated to the specified resource. */ -export type HasMetafields = { - /** The metafield associated with the resource. */ - metafield?: Maybe - /** A paginated list of metafields associated with the resource. */ - metafields: MetafieldConnection -} - -/** Represents information about the metafields associated to the specified resource. */ -export type HasMetafieldsMetafieldArgs = { - namespace: Scalars['String'] - key: Scalars['String'] -} - -/** Represents information about the metafields associated to the specified resource. */ -export type HasMetafieldsMetafieldsArgs = { - namespace?: Maybe - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe -} - -/** Represents an image resource. */ -export type Image = { - __typename?: 'Image' - /** A word or phrase to share the nature or contents of an image. */ - altText?: Maybe - /** The original height of the image in pixels. Returns `null` if the image is not hosted by Shopify. */ - height?: Maybe - /** A unique identifier for the image. */ - id?: Maybe - /** - * The location of the original image as a URL. - * - * If there are any existing transformations in the original source URL, they will remain and not be stripped. - */ - originalSrc: Scalars['URL'] - /** - * The location of the image as a URL. - * @deprecated Previously an image had a single `src` field. This could either return the original image - * location or a URL that contained transformations such as sizing or scale. - * - * These transformations were specified by arguments on the parent field. - * - * Now an image has two distinct URL fields: `originalSrc` and `transformedSrc`. - * - * * `originalSrc` - the original unmodified image URL - * * `transformedSrc` - the image URL with the specified transformations included - * - * To migrate to the new fields, image transformations should be moved from the parent field to `transformedSrc`. - * - * Before: - * ```graphql - * { - * shop { - * productImages(maxWidth: 200, scale: 2) { - * edges { - * node { - * src - * } - * } - * } - * } - * } - * ``` - * - * After: - * ```graphql - * { - * shop { - * productImages { - * edges { - * node { - * transformedSrc(maxWidth: 200, scale: 2) - * } - * } - * } - * } - * } - * ``` - * - */ - src: Scalars['URL'] - /** - * The location of the transformed image as a URL. - * - * All transformation arguments are considered "best-effort". If they can be applied to an image, they will be. - * Otherwise any transformations which an image type does not support will be ignored. - */ - transformedSrc: Scalars['URL'] - /** The original width of the image in pixels. Returns `null` if the image is not hosted by Shopify. */ - width?: Maybe -} - -/** Represents an image resource. */ -export type ImageTransformedSrcArgs = { - maxWidth?: Maybe - maxHeight?: Maybe - crop?: Maybe - scale?: Maybe - preferredContentType?: Maybe -} - -/** An auto-generated type for paginating through multiple Images. */ -export type ImageConnection = { - __typename?: 'ImageConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** List of supported image content types. */ -export enum ImageContentType { - /** A PNG image. */ - Png = 'PNG', - /** A JPG image. */ - Jpg = 'JPG', - /** A WEBP image. */ - Webp = 'WEBP', -} - -/** An auto-generated type which holds one Image and a cursor during pagination. */ -export type ImageEdge = { - __typename?: 'ImageEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of ImageEdge. */ - node: Image -} - -/** Represents a mailing address for customers and shipping. */ -export type MailingAddress = Node & { - __typename?: 'MailingAddress' - /** The first line of the address. Typically the street address or PO Box number. */ - address1?: Maybe - /** The second line of the address. Typically the number of the apartment, suite, or unit. */ - address2?: Maybe - /** The name of the city, district, village, or town. */ - city?: Maybe - /** The name of the customer's company or organization. */ - company?: Maybe - /** The name of the country. */ - country?: Maybe - /** - * The two-letter code for the country of the address. - * - * For example, US. - * @deprecated Use `countryCodeV2` instead - */ - countryCode?: Maybe - /** - * The two-letter code for the country of the address. - * - * For example, US. - */ - countryCodeV2?: Maybe - /** The first name of the customer. */ - firstName?: Maybe - /** A formatted version of the address, customized by the provided arguments. */ - formatted: Array - /** A comma-separated list of the values for city, province, and country. */ - formattedArea?: Maybe - /** Globally unique identifier. */ - id: Scalars['ID'] - /** The last name of the customer. */ - lastName?: Maybe - /** The latitude coordinate of the customer address. */ - latitude?: Maybe - /** The longitude coordinate of the customer address. */ - longitude?: Maybe - /** The full name of the customer, based on firstName and lastName. */ - name?: Maybe - /** - * A unique phone number for the customer. - * - * Formatted using E.164 standard. For example, _+16135551111_. - */ - phone?: Maybe - /** The region of the address, such as the province, state, or district. */ - province?: Maybe - /** - * The two-letter code for the region. - * - * For example, ON. - */ - provinceCode?: Maybe - /** The zip or postal code of the address. */ - zip?: Maybe -} - -/** Represents a mailing address for customers and shipping. */ -export type MailingAddressFormattedArgs = { - withName?: Maybe - withCompany?: Maybe -} - -/** An auto-generated type for paginating through multiple MailingAddresses. */ -export type MailingAddressConnection = { - __typename?: 'MailingAddressConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** An auto-generated type which holds one MailingAddress and a cursor during pagination. */ -export type MailingAddressEdge = { - __typename?: 'MailingAddressEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of MailingAddressEdge. */ - node: MailingAddress -} - -/** Specifies the fields accepted to create or update a mailing address. */ -export type MailingAddressInput = { - /** The first line of the address. Typically the street address or PO Box number. */ - address1?: Maybe - /** The second line of the address. Typically the number of the apartment, suite, or unit. */ - address2?: Maybe - /** The name of the city, district, village, or town. */ - city?: Maybe - /** The name of the customer's company or organization. */ - company?: Maybe - /** The name of the country. */ - country?: Maybe - /** The first name of the customer. */ - firstName?: Maybe - /** The last name of the customer. */ - lastName?: Maybe - /** - * A unique phone number for the customer. - * - * Formatted using E.164 standard. For example, _+16135551111_. - */ - phone?: Maybe - /** The region of the address, such as the province, state, or district. */ - province?: Maybe - /** The zip or postal code of the address. */ - zip?: Maybe -} - -/** Manual discount applications capture the intentions of a discount that was manually created. */ -export type ManualDiscountApplication = DiscountApplication & { - __typename?: 'ManualDiscountApplication' - /** The method by which the discount's value is allocated to its entitled items. */ - allocationMethod: DiscountApplicationAllocationMethod - /** The description of the application. */ - description?: Maybe - /** Which lines of targetType that the discount is allocated over. */ - targetSelection: DiscountApplicationTargetSelection - /** The type of line that the discount is applicable towards. */ - targetType: DiscountApplicationTargetType - /** The title of the application. */ - title: Scalars['String'] - /** The value of the discount application. */ - value: PricingValue -} - -/** Represents a media interface. */ -export type Media = { - /** A word or phrase to share the nature or contents of a media. */ + /** The alt text of the image. */ alt?: Maybe - /** The media content type. */ - mediaContentType: MediaContentType - /** The preview image for the media. */ - previewImage?: Maybe -} - -/** An auto-generated type for paginating through multiple Media. */ -export type MediaConnection = { - __typename?: 'MediaConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** The possible content types for a media object. */ -export enum MediaContentType { - /** An externally hosted video. */ - ExternalVideo = 'EXTERNAL_VIDEO', - /** A Shopify hosted image. */ - Image = 'IMAGE', - /** A 3d model. */ - Model_3D = 'MODEL_3D', - /** A Shopify hosted video. */ - Video = 'VIDEO', -} - -/** An auto-generated type which holds one Media and a cursor during pagination. */ -export type MediaEdge = { - __typename?: 'MediaEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of MediaEdge. */ - node: Media -} - -/** Represents a Shopify hosted image. */ -export type MediaImage = Node & - Media & { - __typename?: 'MediaImage' - /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe - /** Globally unique identifier. */ - id: Scalars['ID'] - /** The image for the media. */ - image?: Maybe - /** The media content type. */ - mediaContentType: MediaContentType - /** The preview image for the media. */ - previewImage?: Maybe - } - -/** - * Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are - * comprised of keys, values, and value types. - */ -export type Metafield = Node & { - __typename?: 'Metafield' - /** The date and time when the storefront metafield was created. */ - createdAt: Scalars['DateTime'] - /** The description of a metafield. */ - description?: Maybe - /** Globally unique identifier. */ - id: Scalars['ID'] - /** The key name for a metafield. */ - key: Scalars['String'] - /** The namespace for a metafield. */ - namespace: Scalars['String'] - /** The parent object that the metafield belongs to. */ - parentResource: MetafieldParentResource - /** The date and time when the storefront metafield was updated. */ - updatedAt: Scalars['DateTime'] - /** The value of a metafield. */ - value: Scalars['String'] - /** Represents the metafield value type. */ - valueType: MetafieldValueType -} - -/** An auto-generated type for paginating through multiple Metafields. */ -export type MetafieldConnection = { - __typename?: 'MetafieldConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** An auto-generated type which holds one Metafield and a cursor during pagination. */ -export type MetafieldEdge = { - __typename?: 'MetafieldEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of MetafieldEdge. */ - node: Metafield -} - -/** A resource that the metafield belongs to. */ -export type MetafieldParentResource = Product | ProductVariant - -/** Metafield value types. */ -export enum MetafieldValueType { - /** A string metafield. */ - String = 'STRING', - /** An integer metafield. */ - Integer = 'INTEGER', - /** A json string metafield. */ - JsonString = 'JSON_STRING', -} - -/** Represents a Shopify hosted 3D model. */ -export type Model3d = Node & - Media & { - __typename?: 'Model3d' - /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe - /** Globally unique identifier. */ - id: Scalars['ID'] - /** The media content type. */ - mediaContentType: MediaContentType - /** The preview image for the media. */ - previewImage?: Maybe - /** The sources for a 3d model. */ - sources: Array - } - -/** Represents a source for a Shopify hosted 3d model. */ -export type Model3dSource = { - __typename?: 'Model3dSource' - /** The filesize of the 3d model. */ - filesize: Scalars['Int'] - /** The format of the 3d model. */ - format: Scalars['String'] - /** The MIME type of the 3d model. */ - mimeType: Scalars['String'] - /** The URL of the 3d model. */ + /** The new relative sorting position of the item (from -inf to +inf). 1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged. */ + sortOrder?: Maybe + /** The URL of the image. */ url: Scalars['String'] } -/** Specifies the fields for a monetary value with currency. */ -export type MoneyInput = { - /** Decimal money amount. */ - amount: Scalars['Decimal'] - /** Currency of the money. */ - currencyCode: CurrencyCode +/** Represents a product image. */ +export type ProductImageUrlArgs = { + size?: Maybe } -/** - * A monetary value with currency. - * - * To format currencies, combine this type's amount and currencyCode fields with your client's locale. - * - * For example, in JavaScript you could use Intl.NumberFormat: - * - * ```js - * new Intl.NumberFormat(locale, { - * style: 'currency', - * currency: currencyCode - * }).format(amount); - * ``` - * - * Other formatting libraries include: - * - * * iOS - [NumberFormatter](https://developer.apple.com/documentation/foundation/numberformatter) - * * Android - [NumberFormat](https://developer.android.com/reference/java/text/NumberFormat.html) - * * PHP - [NumberFormatter](http://php.net/manual/en/class.numberformatter.php) - * - * For a more general solution, the [Unicode CLDR number formatting database] is available with many implementations - * (such as [TwitterCldr](https://github.com/twitter/twitter-cldr-rb)). - */ -export type MoneyV2 = { - __typename?: 'MoneyV2' - /** Decimal money amount. */ - amount: Scalars['Decimal'] - /** Currency of the money. */ - currencyCode: CurrencyCode +/** Represents a product media. */ +export type ProductMedia = Node & { + __typename?: 'ProductMedia' + /** The ID of the object. */ + id: Scalars['ID'] + sortOrder?: Maybe + alt: Scalars['String'] + type: ProductMediaType + oembedData: Scalars['JSONString'] + /** The URL of the media. */ + url: Scalars['String'] } -/** An auto-generated type for paginating through multiple MoneyV2s. */ -export type MoneyV2Connection = { - __typename?: 'MoneyV2Connection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ +/** Represents a product media. */ +export type ProductMediaUrlArgs = { + size?: Maybe +} + +/** An enumeration. */ +export enum ProductMediaType { + /** An uploaded image or an URL to an image */ + Image = 'IMAGE', + /** A URL to an external video */ + Video = 'VIDEO', +} + +export type ProductVariantTranslation = Node & { + __typename?: 'ProductVariantTranslation' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + /** Translation language. */ + language: LanguageDisplay +} + +export type DigitalContent = Node & + ObjectWithMetadata & { + __typename?: 'DigitalContent' + useDefaultSettings: Scalars['Boolean'] + automaticFulfillment: Scalars['Boolean'] + contentFile: Scalars['String'] + maxDownloads?: Maybe + urlValidDays?: Maybe + /** List of URLs for the digital variant. */ + urls?: Maybe>> + /** The ID of the object. */ + id: Scalars['ID'] + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + /** Product variant assigned to digital content. */ + productVariant: ProductVariant + } + +export type DigitalContentUrl = Node & { + __typename?: 'DigitalContentUrl' + content: DigitalContent + created: Scalars['DateTime'] + downloadNum: Scalars['Int'] + /** The ID of the object. */ + id: Scalars['ID'] + /** URL for digital content. */ + url?: Maybe + /** UUID of digital content. */ + token: Scalars['UUID'] +} + +/** Represents stock. */ +export type Stock = Node & { + __typename?: 'Stock' + warehouse: Warehouse + productVariant: ProductVariant + /** Quantity of a product in the warehouse's possession, including the allocated stock that is waiting for shipment. */ + quantity: Scalars['Int'] + /** The ID of the object. */ + id: Scalars['ID'] + /** Quantity allocated for orders */ + quantityAllocated: Scalars['Int'] +} + +/** Represents availability of a product in the storefront. */ +export type ProductPricingInfo = { + __typename?: 'ProductPricingInfo' + /** Whether it is in sale or not. */ + onSale?: Maybe + /** The discount amount if in sale (null otherwise). */ + discount?: Maybe + /** The discount amount in the local currency. */ + discountLocalCurrency?: Maybe + /** The discounted price range of the product variants. */ + priceRange?: Maybe + /** The undiscounted price range of the product variants. */ + priceRangeUndiscounted?: Maybe + /** The discounted price range of the product variants in the local currency. */ + priceRangeLocalCurrency?: Maybe +} + +/** Represents a range of monetary values. */ +export type TaxedMoneyRange = { + __typename?: 'TaxedMoneyRange' + /** Lower bound of a price range. */ + start?: Maybe + /** Upper bound of a price range. */ + stop?: Maybe +} + +/** Represents product channel listing. */ +export type ProductChannelListing = Node & { + __typename?: 'ProductChannelListing' + /** The ID of the object. */ + id: Scalars['ID'] + publicationDate?: Maybe + isPublished: Scalars['Boolean'] + channel: Channel + visibleInListings: Scalars['Boolean'] + availableForPurchase?: Maybe + /** The price of the cheapest variant (including discounts). */ + discountedPrice?: Maybe + /** Purchase cost of product. */ + purchaseCost?: Maybe + /** Range of margin percentage value. */ + margin?: Maybe + /** Whether the product is available for purchase. */ + isAvailableForPurchase?: Maybe + /** Lists the storefront product's pricing, the current price and discounts, only meant for displaying. */ + pricing?: Maybe +} + +/** Represents product channel listing. */ +export type ProductChannelListingPricingArgs = { + address?: Maybe +} + +export type Margin = { + __typename?: 'Margin' + start?: Maybe + stop?: Maybe +} + +/** Represents a collection of products. */ +export type Collection = Node & + ObjectWithMetadata & { + __typename?: 'Collection' + seoTitle?: Maybe + seoDescription?: Maybe + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + description?: Maybe + slug: Scalars['String'] + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + /** + * Description of the collection (JSON). + * @deprecated Will be removed in Saleor 4.0. Use the `description` field instead. + */ + descriptionJson?: Maybe + /** List of products in this collection. */ + products?: Maybe + backgroundImage?: Maybe + /** Returns translated collection fields for the given language code. */ + translation?: Maybe + /** List of channels in which the collection is available. */ + channelListings?: Maybe> + } + +/** Represents a collection of products. */ +export type CollectionProductsArgs = { + filter?: Maybe + sortBy?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +/** Represents a collection of products. */ +export type CollectionBackgroundImageArgs = { + size?: Maybe +} + +/** Represents a collection of products. */ +export type CollectionTranslationArgs = { + languageCode: LanguageCodeEnum +} + +export type ProductFilterInput = { + isPublished?: Maybe + collections?: Maybe>> + categories?: Maybe>> + hasCategory?: Maybe + attributes?: Maybe>> + stockAvailability?: Maybe + productType?: Maybe + stocks?: Maybe + search?: Maybe + metadata?: Maybe>> + price?: Maybe + minimalPrice?: Maybe + productTypes?: Maybe>> + ids?: Maybe>> + /** Specifies the channel by which the data should be sorted. */ + channel?: Maybe +} + +export type AttributeInput = { + /** Internal representation of an attribute name. */ + slug: Scalars['String'] + /** [Deprecated] Internal representation of a value (unique per attribute). This field will be removed after 2020-07-31. */ + value?: Maybe + /** Internal representation of a value (unique per attribute). */ + values?: Maybe>> +} + +export enum StockAvailability { + InStock = 'IN_STOCK', + OutOfStock = 'OUT_OF_STOCK', +} + +export type ProductStockFilterInput = { + warehouseIds?: Maybe> + quantity?: Maybe +} + +export type IntRangeInput = { + /** Value greater than or equal to. */ + gte?: Maybe + /** Value less than or equal to. */ + lte?: Maybe +} + +export type PriceRangeInput = { + /** Price greater than or equal to. */ + gte?: Maybe + /** Price less than or equal to. */ + lte?: Maybe +} + +export type ProductOrder = { + /** Specifies the direction in which to sort products. */ + direction: OrderDirection + /** Specifies the channel in which to sort the data. */ + channel?: Maybe + /** + * Sort product by the selected attribute's values. + * Note: this doesn't take translations into account yet. + */ + attributeId?: Maybe + /** Sort products by the selected field. */ + field?: Maybe +} + +export enum OrderDirection { + /** Specifies an ascending sort order. */ + Asc = 'ASC', + /** Specifies a descending sort order. */ + Desc = 'DESC', +} + +export enum ProductOrderField { + /** Sort products by name. */ + Name = 'NAME', + /** Sort products by rank. Note: This option is available only with the `search` filter. */ + Rank = 'RANK', + /** Sort products by price. */ + Price = 'PRICE', + /** Sort products by a minimal price of a product's variant. */ + MinimalPrice = 'MINIMAL_PRICE', + /** Sort products by update date. */ + Date = 'DATE', + /** Sort products by type. */ + Type = 'TYPE', + /** Sort products by publication status. */ + Published = 'PUBLISHED', + /** Sort products by publication date. */ + PublicationDate = 'PUBLICATION_DATE', + /** Sort products by collection. Note: This option is available only for the `Collection.products` query. */ + Collection = 'COLLECTION', + /** Sort products by rating. */ + Rating = 'RATING', +} + +export type CollectionTranslation = Node & { + __typename?: 'CollectionTranslation' + seoTitle?: Maybe + seoDescription?: Maybe + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + description?: Maybe + /** Translation language. */ + language: LanguageDisplay + /** + * Translated description of the product (JSON). + * @deprecated Will be removed in Saleor 4.0. Use the `description` field instead. + */ + descriptionJson?: Maybe +} + +/** Represents collection channel listing. */ +export type CollectionChannelListing = Node & { + __typename?: 'CollectionChannelListing' + publicationDate?: Maybe + isPublished: Scalars['Boolean'] + /** The ID of the object. */ + id: Scalars['ID'] + channel: Channel +} + +export type ProductTranslation = Node & { + __typename?: 'ProductTranslation' + /** The ID of the object. */ + id: Scalars['ID'] + seoTitle?: Maybe + seoDescription?: Maybe + name: Scalars['String'] + description?: Maybe + /** Translation language. */ + language: LanguageDisplay + /** + * Translated description of the product (JSON). + * @deprecated Will be removed in Saleor 4.0. Use the `description` field instead. + */ + descriptionJson?: Maybe +} + +/** Represents user address data. */ +export type Address = Node & { + __typename?: 'Address' + /** The ID of the object. */ + id: Scalars['ID'] + firstName: Scalars['String'] + lastName: Scalars['String'] + companyName: Scalars['String'] + streetAddress1: Scalars['String'] + streetAddress2: Scalars['String'] + city: Scalars['String'] + cityArea: Scalars['String'] + postalCode: Scalars['String'] + /** Shop's default country. */ + country: CountryDisplay + countryArea: Scalars['String'] + phone?: Maybe + /** Address is user's default shipping address. */ + isDefaultShippingAddress?: Maybe + /** Address is user's default billing address. */ + isDefaultBillingAddress?: Maybe +} + +export type WarehouseCountableConnection = { + __typename?: 'WarehouseCountableConnection' + /** Pagination data for this connection. */ pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe } -/** An auto-generated type which holds one MoneyV2 and a cursor during pagination. */ -export type MoneyV2Edge = { - __typename?: 'MoneyV2Edge' +export type WarehouseCountableEdge = { + __typename?: 'WarehouseCountableEdge' + /** The item at the end of the edge. */ + node: Warehouse /** A cursor for use in pagination. */ cursor: Scalars['String'] - /** The item at the end of MoneyV2Edge. */ - node: MoneyV2 } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type WarehouseFilterInput = { + search?: Maybe + ids?: Maybe>> +} + +export type WarehouseSortingInput = { + /** Specifies the direction in which to sort products. */ + direction: OrderDirection + /** Sort warehouses by the selected field. */ + field: WarehouseSortField +} + +export enum WarehouseSortField { + /** Sort warehouses by name. */ + Name = 'NAME', +} + +export type TranslatableItemConnection = { + __typename?: 'TranslatableItemConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type TranslatableItemEdge = { + __typename?: 'TranslatableItemEdge' + /** The item at the end of the edge. */ + node: TranslatableItem + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type TranslatableItem = + | ProductTranslatableContent + | CollectionTranslatableContent + | CategoryTranslatableContent + | AttributeTranslatableContent + | AttributeValueTranslatableContent + | ProductVariantTranslatableContent + | PageTranslatableContent + | ShippingMethodTranslatableContent + | SaleTranslatableContent + | VoucherTranslatableContent + | MenuItemTranslatableContent + +export type ProductTranslatableContent = Node & { + __typename?: 'ProductTranslatableContent' + /** The ID of the object. */ + id: Scalars['ID'] + seoTitle?: Maybe + seoDescription?: Maybe + name: Scalars['String'] + description?: Maybe + /** + * Description of the product (JSON). + * @deprecated Will be removed in Saleor 4.0. Use the `description` field instead. + */ + descriptionJson?: Maybe + /** Returns translated product fields for the given language code. */ + translation?: Maybe + /** Represents an individual item for sale in the storefront. */ + product?: Maybe +} + +export type ProductTranslatableContentTranslationArgs = { + languageCode: LanguageCodeEnum +} + +export type CollectionTranslatableContent = Node & { + __typename?: 'CollectionTranslatableContent' + seoTitle?: Maybe + seoDescription?: Maybe + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + description?: Maybe + /** + * Description of the collection (JSON). + * @deprecated Will be removed in Saleor 4.0. Use the `description` field instead. + */ + descriptionJson?: Maybe + /** Returns translated collection fields for the given language code. */ + translation?: Maybe + /** Represents a collection of products. */ + collection?: Maybe +} + +export type CollectionTranslatableContentTranslationArgs = { + languageCode: LanguageCodeEnum +} + +export type CategoryTranslatableContent = Node & { + __typename?: 'CategoryTranslatableContent' + seoTitle?: Maybe + seoDescription?: Maybe + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + description?: Maybe + /** + * Description of the category (JSON). + * @deprecated Will be removed in Saleor 4.0. Use the `description` field instead. + */ + descriptionJson?: Maybe + /** Returns translated category fields for the given language code. */ + translation?: Maybe + /** Represents a single category of products. */ + category?: Maybe +} + +export type CategoryTranslatableContentTranslationArgs = { + languageCode: LanguageCodeEnum +} + +export type AttributeTranslatableContent = Node & { + __typename?: 'AttributeTranslatableContent' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + /** Returns translated attribute fields for the given language code. */ + translation?: Maybe + /** Custom attribute of a product. */ + attribute?: Maybe +} + +export type AttributeTranslatableContentTranslationArgs = { + languageCode: LanguageCodeEnum +} + +export type AttributeValueTranslatableContent = Node & { + __typename?: 'AttributeValueTranslatableContent' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + /** Returns translated attribute value fields for the given language code. */ + translation?: Maybe + /** Represents a value of an attribute. */ + attributeValue?: Maybe +} + +export type AttributeValueTranslatableContentTranslationArgs = { + languageCode: LanguageCodeEnum +} + +export type ProductVariantTranslatableContent = Node & { + __typename?: 'ProductVariantTranslatableContent' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + /** Returns translated product variant fields for the given language code. */ + translation?: Maybe + /** Represents a version of a product such as different size or color. */ + productVariant?: Maybe +} + +export type ProductVariantTranslatableContentTranslationArgs = { + languageCode: LanguageCodeEnum +} + +export type PageTranslatableContent = Node & { + __typename?: 'PageTranslatableContent' + seoTitle?: Maybe + seoDescription?: Maybe + /** The ID of the object. */ + id: Scalars['ID'] + title: Scalars['String'] + content?: Maybe + /** + * Content of the page (JSON). + * @deprecated Will be removed in Saleor 4.0. Use the `content` field instead. + */ + contentJson?: Maybe + /** Returns translated page fields for the given language code. */ + translation?: Maybe + /** ('A static page that can be manually added by a shop operator ', 'through the dashboard.') */ + page?: Maybe +} + +export type PageTranslatableContentTranslationArgs = { + languageCode: LanguageCodeEnum +} + +export type PageTranslation = Node & { + __typename?: 'PageTranslation' + seoTitle?: Maybe + seoDescription?: Maybe + /** The ID of the object. */ + id: Scalars['ID'] + title: Scalars['String'] + content?: Maybe + /** Translation language. */ + language: LanguageDisplay + /** + * Translated description of the page (JSON). + * @deprecated Will be removed in Saleor 4.0. Use the `content` field instead. + */ + contentJson?: Maybe +} + +/** A static page that can be manually added by a shop operator through the dashboard. */ +export type Page = Node & + ObjectWithMetadata & { + __typename?: 'Page' + seoTitle?: Maybe + seoDescription?: Maybe + /** The ID of the object. */ + id: Scalars['ID'] + title: Scalars['String'] + content?: Maybe + publicationDate?: Maybe + isPublished: Scalars['Boolean'] + slug: Scalars['String'] + pageType: PageType + created: Scalars['DateTime'] + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + /** + * Content of the page (JSON). + * @deprecated Will be removed in Saleor 4.0. Use the `content` field instead. + */ + contentJson: Scalars['JSONString'] + /** Returns translated page fields for the given language code. */ + translation?: Maybe + /** List of attributes assigned to this product. */ + attributes: Array + } + +/** A static page that can be manually added by a shop operator through the dashboard. */ +export type PageTranslationArgs = { + languageCode: LanguageCodeEnum +} + +/** Represents a type of page. It defines what attributes are available to pages of this type. */ +export type PageType = Node & + ObjectWithMetadata & { + __typename?: 'PageType' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + slug: Scalars['String'] + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + /** Page attributes of that page type. */ + attributes?: Maybe>> + /** Attributes that can be assigned to the page type. */ + availableAttributes?: Maybe + /** Whether page type has pages assigned. */ + hasPages?: Maybe + } + +/** Represents a type of page. It defines what attributes are available to pages of this type. */ +export type PageTypeAvailableAttributesArgs = { + filter?: Maybe + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +export type ShippingMethodTranslatableContent = Node & { + __typename?: 'ShippingMethodTranslatableContent' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + /** Returns translated shipping method fields for the given language code. */ + translation?: Maybe + /** Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers. */ + shippingMethod?: Maybe +} + +export type ShippingMethodTranslatableContentTranslationArgs = { + languageCode: LanguageCodeEnum +} + +export type SaleTranslatableContent = Node & { + __typename?: 'SaleTranslatableContent' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + /** Returns translated sale fields for the given language code. */ + translation?: Maybe + /** Sales allow creating discounts for categories, collections or products and are visible to all the customers. */ + sale?: Maybe +} + +export type SaleTranslatableContentTranslationArgs = { + languageCode: LanguageCodeEnum +} + +export type SaleTranslation = Node & { + __typename?: 'SaleTranslation' + /** The ID of the object. */ + id: Scalars['ID'] + name?: Maybe + /** Translation language. */ + language: LanguageDisplay +} + +/** Sales allow creating discounts for categories, collections or products and are visible to all the customers. */ +export type Sale = Node & { + __typename?: 'Sale' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + type: SaleType + startDate: Scalars['DateTime'] + endDate?: Maybe + /** List of categories this sale applies to. */ + categories?: Maybe + /** List of collections this sale applies to. */ + collections?: Maybe + /** List of products this sale applies to. */ + products?: Maybe + /** Returns translated sale fields for the given language code. */ + translation?: Maybe + /** List of channels available for the sale. */ + channelListings?: Maybe> + /** Sale value. */ + discountValue?: Maybe + /** Currency code for sale. */ + currency?: Maybe +} + +/** Sales allow creating discounts for categories, collections or products and are visible to all the customers. */ +export type SaleCategoriesArgs = { + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +/** Sales allow creating discounts for categories, collections or products and are visible to all the customers. */ +export type SaleCollectionsArgs = { + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +/** Sales allow creating discounts for categories, collections or products and are visible to all the customers. */ +export type SaleProductsArgs = { + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +/** Sales allow creating discounts for categories, collections or products and are visible to all the customers. */ +export type SaleTranslationArgs = { + languageCode: LanguageCodeEnum +} + +/** An enumeration. */ +export enum SaleType { + /** fixed */ + Fixed = 'FIXED', + /** % */ + Percentage = 'PERCENTAGE', +} + +export type CollectionCountableConnection = { + __typename?: 'CollectionCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type CollectionCountableEdge = { + __typename?: 'CollectionCountableEdge' + /** The item at the end of the edge. */ + node: Collection + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +/** Represents sale channel listing. */ +export type SaleChannelListing = Node & { + __typename?: 'SaleChannelListing' + /** The ID of the object. */ + id: Scalars['ID'] + channel: Channel + discountValue: Scalars['Float'] + currency: Scalars['String'] +} + +export type VoucherTranslatableContent = Node & { + __typename?: 'VoucherTranslatableContent' + /** The ID of the object. */ + id: Scalars['ID'] + name?: Maybe + /** Returns translated voucher fields for the given language code. */ + translation?: Maybe + /** Vouchers allow giving discounts to particular customers on categories, collections or specific products. They can be used during checkout by providing valid voucher codes. */ + voucher?: Maybe +} + +export type VoucherTranslatableContentTranslationArgs = { + languageCode: LanguageCodeEnum +} + +export type VoucherTranslation = Node & { + __typename?: 'VoucherTranslation' + /** The ID of the object. */ + id: Scalars['ID'] + name?: Maybe + /** Translation language. */ + language: LanguageDisplay +} + +/** Vouchers allow giving discounts to particular customers on categories, collections or specific products. They can be used during checkout by providing valid voucher codes. */ +export type Voucher = Node & { + __typename?: 'Voucher' + /** The ID of the object. */ + id: Scalars['ID'] + name?: Maybe + /** Determines a type of voucher. */ + type: VoucherTypeEnum + code: Scalars['String'] + usageLimit?: Maybe + used: Scalars['Int'] + startDate: Scalars['DateTime'] + endDate?: Maybe + applyOncePerOrder: Scalars['Boolean'] + applyOncePerCustomer: Scalars['Boolean'] + /** Determines a type of discount for voucher - value or percentage */ + discountValueType: DiscountValueTypeEnum + minCheckoutItemsQuantity?: Maybe + /** List of categories this voucher applies to. */ + categories?: Maybe + /** List of collections this voucher applies to. */ + collections?: Maybe + /** List of products this voucher applies to. */ + products?: Maybe + /** List of countries available for the shipping voucher. */ + countries?: Maybe>> + /** Returns translated voucher fields for the given language code. */ + translation?: Maybe + /** Voucher value. */ + discountValue?: Maybe + /** Currency code for voucher. */ + currency?: Maybe + /** Minimum order value to apply voucher. */ + minSpent?: Maybe + /** List of availability in channels for the voucher. */ + channelListings?: Maybe> +} + +/** Vouchers allow giving discounts to particular customers on categories, collections or specific products. They can be used during checkout by providing valid voucher codes. */ +export type VoucherCategoriesArgs = { + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +/** Vouchers allow giving discounts to particular customers on categories, collections or specific products. They can be used during checkout by providing valid voucher codes. */ +export type VoucherCollectionsArgs = { + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +/** Vouchers allow giving discounts to particular customers on categories, collections or specific products. They can be used during checkout by providing valid voucher codes. */ +export type VoucherProductsArgs = { + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +/** Vouchers allow giving discounts to particular customers on categories, collections or specific products. They can be used during checkout by providing valid voucher codes. */ +export type VoucherTranslationArgs = { + languageCode: LanguageCodeEnum +} + +export enum VoucherTypeEnum { + Shipping = 'SHIPPING', + EntireOrder = 'ENTIRE_ORDER', + SpecificProduct = 'SPECIFIC_PRODUCT', +} + +export enum DiscountValueTypeEnum { + Fixed = 'FIXED', + Percentage = 'PERCENTAGE', +} + +/** Represents voucher channel listing. */ +export type VoucherChannelListing = Node & { + __typename?: 'VoucherChannelListing' + /** The ID of the object. */ + id: Scalars['ID'] + channel: Channel + discountValue: Scalars['Float'] + currency: Scalars['String'] + minSpent?: Maybe +} + +export type MenuItemTranslatableContent = Node & { + __typename?: 'MenuItemTranslatableContent' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + /** Returns translated menu item fields for the given language code. */ + translation?: Maybe + /** Represents a single item of the related menu. Can store categories, collection or pages. */ + menuItem?: Maybe +} + +export type MenuItemTranslatableContentTranslationArgs = { + languageCode: LanguageCodeEnum +} + +export type MenuItemTranslation = Node & { + __typename?: 'MenuItemTranslation' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + /** Translation language. */ + language: LanguageDisplay +} + +/** Represents a single item of the related menu. Can store categories, collection or pages. */ +export type MenuItem = Node & + ObjectWithMetadata & { + __typename?: 'MenuItem' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + menu: Menu + parent?: Maybe + category?: Maybe + collection?: Maybe + page?: Maybe + level: Scalars['Int'] + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + children?: Maybe>> + /** URL to the menu item. */ + url?: Maybe + /** Returns translated menu item fields for the given language code. */ + translation?: Maybe + } + +/** Represents a single item of the related menu. Can store categories, collection or pages. */ +export type MenuItemTranslationArgs = { + languageCode: LanguageCodeEnum +} + +/** Represents a single menu - an object that is used to help navigate through the store. */ +export type Menu = Node & + ObjectWithMetadata & { + __typename?: 'Menu' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + slug: Scalars['String'] + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + items?: Maybe>> + } + +export enum TranslatableKinds { + Attribute = 'ATTRIBUTE', + AttributeValue = 'ATTRIBUTE_VALUE', + Category = 'CATEGORY', + Collection = 'COLLECTION', + MenuItem = 'MENU_ITEM', + Page = 'PAGE', + Product = 'PRODUCT', + Sale = 'SALE', + ShippingMethod = 'SHIPPING_METHOD', + Variant = 'VARIANT', + Voucher = 'VOUCHER', +} + +export type StockCountableConnection = { + __typename?: 'StockCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type StockCountableEdge = { + __typename?: 'StockCountableEdge' + /** The item at the end of the edge. */ + node: Stock + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type StockFilterInput = { + quantity?: Maybe + search?: Maybe +} + +/** Represents a shop resource containing general shop data and configuration. */ +export type Shop = { + __typename?: 'Shop' + /** List of available payment gateways. */ + availablePaymentGateways: Array + /** List of available external authentications. */ + availableExternalAuthentications: Array + /** Shipping methods that are available for the shop. */ + availableShippingMethods?: Maybe>> + /** List of countries available in the shop. */ + countries: Array + /** Shop's default country. */ + defaultCountry?: Maybe + /** Default shop's email sender's name. */ + defaultMailSenderName?: Maybe + /** Default shop's email sender's address. */ + defaultMailSenderAddress?: Maybe + /** Shop's description. */ + description?: Maybe + /** Shop's domain data. */ + domain: Domain + /** List of the shops's supported languages. */ + languages: Array> + /** Shop's name. */ + name: Scalars['String'] + /** + * Shop's navigation. + * @deprecated Fetch menus using the `menu` query with `slug` parameter. + */ + navigation?: Maybe + /** List of available permissions. */ + permissions: Array> + /** List of possible phone prefixes. */ + phonePrefixes: Array> + /** Header text. */ + headerText?: Maybe + /** Include taxes in prices. */ + includeTaxesInPrices: Scalars['Boolean'] + /** Display prices with tax in store. */ + displayGrossPrices: Scalars['Boolean'] + /** Charge taxes on shipping. */ + chargeTaxesOnShipping: Scalars['Boolean'] + /** Enable inventory tracking. */ + trackInventoryByDefault?: Maybe + /** Default weight unit. */ + defaultWeightUnit?: Maybe + /** Returns translated shop fields for the given language code. */ + translation?: Maybe + /** Enable automatic fulfillment for all digital products. */ + automaticFulfillmentDigitalProducts?: Maybe + /** Default number of max downloads per digital content URL. */ + defaultDigitalMaxDownloads?: Maybe + /** Default number of days which digital content URL will be valid. */ + defaultDigitalUrlValidDays?: Maybe + /** Company address. */ + companyAddress?: Maybe
+ /** URL of a view where customers can set their password. */ + customerSetPasswordUrl?: Maybe + /** List of staff notification recipients. */ + staffNotificationRecipients?: Maybe>> + /** Resource limitations and current usage if any set for a shop */ + limits: LimitInfo + /** Saleor API version. */ + version: Scalars['String'] +} + +/** Represents a shop resource containing general shop data and configuration. */ +export type ShopAvailablePaymentGatewaysArgs = { + currency?: Maybe +} + +/** Represents a shop resource containing general shop data and configuration. */ +export type ShopAvailableShippingMethodsArgs = { + channel: Scalars['String'] + address?: Maybe +} + +/** Represents a shop resource containing general shop data and configuration. */ +export type ShopCountriesArgs = { + languageCode?: Maybe +} + +/** Represents a shop resource containing general shop data and configuration. */ +export type ShopTranslationArgs = { + languageCode: LanguageCodeEnum +} + +/** Available payment gateway backend with configuration necessary to setup client. */ +export type PaymentGateway = { + __typename?: 'PaymentGateway' + /** Payment gateway name. */ + name: Scalars['String'] + /** Payment gateway ID. */ + id: Scalars['ID'] + /** Payment gateway client configuration. */ + config: Array + /** Payment gateway supported currencies. */ + currencies: Array> +} + +/** Payment gateway client configuration key and value pair. */ +export type GatewayConfigLine = { + __typename?: 'GatewayConfigLine' + /** Gateway config key. */ + field: Scalars['String'] + /** Gateway config value for key. */ + value?: Maybe +} + +export type ExternalAuthentication = { + __typename?: 'ExternalAuthentication' + /** ID of external authentication plugin. */ + id: Scalars['String'] + /** Name of external authentication plugin. */ + name?: Maybe +} + +/** Represents shop's domain. */ +export type Domain = { + __typename?: 'Domain' + /** The host name of the domain. */ + host: Scalars['String'] + /** Inform if SSL is enabled. */ + sslEnabled: Scalars['Boolean'] + /** Shop's absolute URL. */ + url: Scalars['String'] +} + +/** Represents shop's navigation menus. */ +export type Navigation = { + __typename?: 'Navigation' + /** Main navigation bar. */ + main?: Maybe + /** Secondary navigation bar. */ + secondary?: Maybe +} + +export type ShopTranslation = Node & { + __typename?: 'ShopTranslation' + /** The ID of the object. */ + id: Scalars['ID'] + headerText: Scalars['String'] + description: Scalars['String'] + /** Translation language. */ + language: LanguageDisplay +} + +/** Represents a recipient of email notifications send by Saleor, such as notifications about new orders. Notifications can be assigned to staff users or arbitrary email addresses. */ +export type StaffNotificationRecipient = Node & { + __typename?: 'StaffNotificationRecipient' + /** Returns a user subscribed to email notifications. */ + user?: Maybe + /** Determines if a notification active. */ + active?: Maybe + /** The ID of the object. */ + id: Scalars['ID'] + /** Returns email address of a user subscribed to email notifications. */ + email?: Maybe +} + +/** Represents user data. */ +export type User = Node & + ObjectWithMetadata & { + __typename?: 'User' + /** The ID of the object. */ + id: Scalars['ID'] + lastLogin?: Maybe + email: Scalars['String'] + firstName: Scalars['String'] + lastName: Scalars['String'] + isStaff: Scalars['Boolean'] + isActive: Scalars['Boolean'] + /** A note about the customer. */ + note?: Maybe + dateJoined: Scalars['DateTime'] + defaultShippingAddress?: Maybe
+ defaultBillingAddress?: Maybe
+ /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + /** List of all user's addresses. */ + addresses?: Maybe>> + /** + * Returns the last open checkout of this user. + * @deprecated Use the `checkout_tokens` field to fetch the user checkouts. + */ + checkout?: Maybe + /** Returns the checkout UUID's assigned to this user. */ + checkoutTokens?: Maybe> + /** List of the user gift cards. */ + giftCards?: Maybe + /** List of user's orders. */ + orders?: Maybe + /** + * List of user's permissions. + * @deprecated Will be removed in Saleor 2.11.Use the `userPermissions` instead. + */ + permissions?: Maybe>> + /** List of user's permissions. */ + userPermissions?: Maybe>> + /** List of user's permission groups. */ + permissionGroups?: Maybe>> + /** List of user's permission groups which user can manage. */ + editableGroups?: Maybe>> + avatar?: Maybe + /** List of events associated with the user. */ + events?: Maybe>> + /** List of stored payment sources. */ + storedPaymentSources?: Maybe>> + /** User language code. */ + languageCode: LanguageCodeEnum + } + +/** Represents user data. */ +export type UserCheckoutTokensArgs = { + channel?: Maybe +} + +/** Represents user data. */ +export type UserGiftCardsArgs = { + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +/** Represents user data. */ +export type UserOrdersArgs = { + before?: Maybe + after?: Maybe + first?: Maybe + last?: Maybe +} + +/** Represents user data. */ +export type UserAvatarArgs = { + size?: Maybe +} + +/** Checkout object. */ +export type Checkout = Node & + ObjectWithMetadata & { + __typename?: 'Checkout' + created: Scalars['DateTime'] + lastChange: Scalars['DateTime'] + user?: Maybe + quantity: Scalars['Int'] + channel: Channel + billingAddress?: Maybe
+ shippingAddress?: Maybe
+ note: Scalars['String'] + discount?: Maybe + discountName?: Maybe + translatedDiscountName?: Maybe + voucherCode?: Maybe + /** List of gift cards associated with this checkout. */ + giftCards?: Maybe>> + /** The ID of the object. */ + id: Scalars['ID'] + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + /** Shipping methods that can be used with this order. */ + availableShippingMethods: Array> + /** List of available payment gateways. */ + availablePaymentGateways: Array + /** Email of a customer. */ + email: Scalars['String'] + /** Returns True, if checkout requires shipping. */ + isShippingRequired: Scalars['Boolean'] + /** A list of checkout lines, each containing information about an item in the checkout. */ + lines?: Maybe>> + /** The price of the shipping, with all the taxes included. */ + shippingPrice?: Maybe + /** The shipping method related with checkout. */ + shippingMethod?: Maybe + /** The price of the checkout before shipping, with taxes included. */ + subtotalPrice?: Maybe + /** The checkout's token. */ + token: Scalars['UUID'] + /** The sum of the the checkout line prices, with all the taxes,shipping costs, and discounts included. */ + totalPrice?: Maybe + /** Checkout language code. */ + languageCode: LanguageCodeEnum + } + +/** A gift card is a prepaid electronic payment card accepted in stores. They can be used during checkout by providing a valid gift card codes. */ +export type GiftCard = Node & { + __typename?: 'GiftCard' + /** Gift card code. */ + code?: Maybe + /** The customer who bought a gift card. */ + user?: Maybe + created: Scalars['DateTime'] + startDate: Scalars['Date'] + endDate?: Maybe + lastUsedOn?: Maybe + isActive: Scalars['Boolean'] + initialBalance?: Maybe + currentBalance?: Maybe + /** The ID of the object. */ + id: Scalars['ID'] + /** Code in format which allows displaying in a user interface. */ + displayCode?: Maybe +} + +/** Represents an item in the checkout. */ +export type CheckoutLine = Node & { + __typename?: 'CheckoutLine' + /** The ID of the object. */ + id: Scalars['ID'] + variant: ProductVariant + quantity: Scalars['Int'] + /** The sum of the checkout line price, taxes and discounts. */ + totalPrice?: Maybe + /** Indicates whether the item need to be delivered. */ + requiresShipping?: Maybe +} + +export type GiftCardCountableConnection = { + __typename?: 'GiftCardCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type GiftCardCountableEdge = { + __typename?: 'GiftCardCountableEdge' + /** The item at the end of the edge. */ + node: GiftCard + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type OrderCountableConnection = { + __typename?: 'OrderCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type OrderCountableEdge = { + __typename?: 'OrderCountableEdge' + /** The item at the end of the edge. */ + node: Order + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +/** Represents an order in the shop. */ +export type Order = Node & + ObjectWithMetadata & { + __typename?: 'Order' + /** The ID of the object. */ + id: Scalars['ID'] + created: Scalars['DateTime'] + status: OrderStatus + user?: Maybe + trackingClientId: Scalars['String'] + billingAddress?: Maybe
+ shippingAddress?: Maybe
+ shippingMethod?: Maybe + shippingMethodName?: Maybe + channel: Channel + /** Total price of shipping. */ + shippingPrice: TaxedMoney + shippingTaxRate: Scalars['Float'] + token: Scalars['String'] + voucher?: Maybe + /** List of user gift cards. */ + giftCards?: Maybe>> + displayGrossPrices: Scalars['Boolean'] + customerNote: Scalars['String'] + weight?: Maybe + redirectUrl?: Maybe + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + /** List of shipments for the order. */ + fulfillments: Array> + /** List of order lines. */ + lines: Array> + /** List of actions that can be performed in the current state of an order. */ + actions: Array> + /** Shipping methods that can be used with this order. */ + availableShippingMethods?: Maybe>> + /** List of order invoices. */ + invoices?: Maybe>> + /** User-friendly number of an order. */ + number?: Maybe + /** Informs if an order is fully paid. */ + isPaid: Scalars['Boolean'] + /** Internal payment status. */ + paymentStatus: PaymentChargeStatusEnum + /** User-friendly payment status. */ + paymentStatusDisplay: Scalars['String'] + /** List of payments for the order. */ + payments?: Maybe>> + /** Total amount of the order. */ + total: TaxedMoney + /** Undiscounted total amount of the order. */ + undiscountedTotal: TaxedMoney + /** The sum of line prices not including shipping. */ + subtotal: TaxedMoney + /** User-friendly order status. */ + statusDisplay?: Maybe + /** Informs whether a draft order can be finalized(turned into a regular order). */ + canFinalize: Scalars['Boolean'] + /** Amount authorized for the order. */ + totalAuthorized: Money + /** Amount captured by payment. */ + totalCaptured: Money + /** List of events associated with the order. */ + events?: Maybe>> + /** The difference between the paid and the order total amount. */ + totalBalance: Money + /** Email address of the customer. */ + userEmail?: Maybe + /** Returns True, if order requires shipping. */ + isShippingRequired: Scalars['Boolean'] + /** @deprecated Use the `languageCodeEnum` field to fetch the language code. This field will be removed in Saleor 4.0. */ + languageCode: Scalars['String'] + /** Order language code. */ + languageCodeEnum: LanguageCodeEnum + /** + * Returns applied discount. + * @deprecated Use discounts field. This field will be removed in Saleor 4.0. + */ + discount?: Maybe + /** + * Discount name. + * @deprecated Use discounts field. This field will be removed in Saleor 4.0. + */ + discountName?: Maybe + /** + * Translated discount name. + * @deprecated Use discounts field. This field will be removed in Saleor 4.0. + */ + translatedDiscountName?: Maybe + /** List of all discounts assigned to the order. */ + discounts?: Maybe> + } + +/** An enumeration. */ +export enum OrderStatus { + /** Draft */ + Draft = 'DRAFT', + /** Unconfirmed */ + Unconfirmed = 'UNCONFIRMED', + /** Unfulfilled */ + Unfulfilled = 'UNFULFILLED', + /** Partially fulfilled */ + PartiallyFulfilled = 'PARTIALLY_FULFILLED', + /** Partially returned */ + PartiallyReturned = 'PARTIALLY_RETURNED', + /** Returned */ + Returned = 'RETURNED', + /** Fulfilled */ + Fulfilled = 'FULFILLED', + /** Canceled */ + Canceled = 'CANCELED', +} + +/** Represents order fulfillment. */ +export type Fulfillment = Node & + ObjectWithMetadata & { + __typename?: 'Fulfillment' + /** The ID of the object. */ + id: Scalars['ID'] + fulfillmentOrder: Scalars['Int'] + status: FulfillmentStatus + trackingNumber: Scalars['String'] + created: Scalars['DateTime'] + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + /** List of lines for the fulfillment. */ + lines?: Maybe>> + /** User-friendly fulfillment status. */ + statusDisplay?: Maybe + /** Warehouse from fulfillment was fulfilled. */ + warehouse?: Maybe + } + +/** An enumeration. */ +export enum FulfillmentStatus { + /** Fulfilled */ + Fulfilled = 'FULFILLED', + /** Refunded */ + Refunded = 'REFUNDED', + /** Returned */ + Returned = 'RETURNED', + /** Replaced */ + Replaced = 'REPLACED', + /** Refunded and returned */ + RefundedAndReturned = 'REFUNDED_AND_RETURNED', + /** Canceled */ + Canceled = 'CANCELED', +} + +/** Represents line of the fulfillment. */ +export type FulfillmentLine = Node & { + __typename?: 'FulfillmentLine' + /** The ID of the object. */ + id: Scalars['ID'] + quantity: Scalars['Int'] + orderLine?: Maybe +} + +/** Represents order line of particular order. */ +export type OrderLine = Node & { + __typename?: 'OrderLine' + /** The ID of the object. */ + id: Scalars['ID'] + productName: Scalars['String'] + variantName: Scalars['String'] + productSku: Scalars['String'] + isShippingRequired: Scalars['Boolean'] + quantity: Scalars['Int'] + quantityFulfilled: Scalars['Int'] + unitDiscountReason?: Maybe + taxRate: Scalars['Float'] + digitalContentUrl?: Maybe + /** The main thumbnail for the ordered product. */ + thumbnail?: Maybe + /** Price of the single item in the order line. */ + unitPrice: TaxedMoney + /** Price of the single item in the order line without applied an order line discount. */ + undiscountedUnitPrice: TaxedMoney + /** The discount applied to the single order line. */ + unitDiscount: Money + /** Value of the discount. Can store fixed value or percent value */ + unitDiscountValue: Scalars['PositiveDecimal'] + /** Price of the order line. */ + totalPrice: TaxedMoney + /** A purchased product variant. Note: this field may be null if the variant has been removed from stock at all. */ + variant?: Maybe + /** Product name in the customer's language */ + translatedProductName: Scalars['String'] + /** Variant name in the customer's language */ + translatedVariantName: Scalars['String'] + /** List of allocations across warehouses. */ + allocations?: Maybe> + /** Type of the discount: fixed or percent */ + unitDiscountType?: Maybe +} + +/** Represents order line of particular order. */ +export type OrderLineThumbnailArgs = { + size?: Maybe +} + +/** Represents allocation. */ +export type Allocation = Node & { + __typename?: 'Allocation' + /** The ID of the object. */ + id: Scalars['ID'] + /** Quantity allocated for orders. */ + quantity: Scalars['Int'] + /** The warehouse were items were allocated. */ + warehouse: Warehouse +} + +export enum OrderAction { + /** Represents the capture action. */ + Capture = 'CAPTURE', + /** Represents a mark-as-paid action. */ + MarkAsPaid = 'MARK_AS_PAID', + /** Represents a refund action. */ + Refund = 'REFUND', + /** Represents a void action. */ + Void = 'VOID', +} + +/** Represents an Invoice. */ +export type Invoice = ObjectWithMetadata & + Job & + Node & { + __typename?: 'Invoice' + /** The ID of the object. */ + id: Scalars['ID'] + /** List of public metadata items. Can be accessed without permissions. */ + metadata: Array> + /** Job status. */ + status: JobStatusEnum + number?: Maybe + externalUrl?: Maybe + /** List of private metadata items.Requires proper staff permissions to access. */ + privateMetadata: Array> + /** Created date time of job in ISO 8601 format. */ + createdAt: Scalars['DateTime'] + /** Date time of job last update in ISO 8601 format. */ + updatedAt: Scalars['DateTime'] + /** Job message. */ + message?: Maybe + /** URL to download an invoice. */ + url?: Maybe + } + +export type Job = { + /** Job status. */ + status: JobStatusEnum + /** Created date time of job in ISO 8601 format. */ + createdAt: Scalars['DateTime'] + /** Date time of job last update in ISO 8601 format. */ + updatedAt: Scalars['DateTime'] + /** Job message. */ + message?: Maybe +} + +/** An enumeration. */ +export enum JobStatusEnum { + Pending = 'PENDING', + Success = 'SUCCESS', + Failed = 'FAILED', + Deleted = 'DELETED', +} + +/** An enumeration. */ +export enum PaymentChargeStatusEnum { + NotCharged = 'NOT_CHARGED', + Pending = 'PENDING', + PartiallyCharged = 'PARTIALLY_CHARGED', + FullyCharged = 'FULLY_CHARGED', + PartiallyRefunded = 'PARTIALLY_REFUNDED', + FullyRefunded = 'FULLY_REFUNDED', + Refused = 'REFUSED', + Cancelled = 'CANCELLED', +} + +/** Represents a payment of a given type. */ +export type Payment = Node & { + __typename?: 'Payment' + /** The ID of the object. */ + id: Scalars['ID'] + gateway: Scalars['String'] + isActive: Scalars['Boolean'] + created: Scalars['DateTime'] + modified: Scalars['DateTime'] + token: Scalars['String'] + checkout?: Maybe + order?: Maybe + paymentMethodType: Scalars['String'] + customerIpAddress?: Maybe + /** Internal payment status. */ + chargeStatus: PaymentChargeStatusEnum + /** List of actions that can be performed in the current state of a payment. */ + actions: Array> + /** Total amount of the payment. */ + total?: Maybe + /** Total amount captured for this payment. */ + capturedAmount?: Maybe + /** List of all transactions within this payment. */ + transactions?: Maybe>> + /** Maximum amount of money that can be captured. */ + availableCaptureAmount?: Maybe + /** Maximum amount of money that can be refunded. */ + availableRefundAmount?: Maybe + /** The details of the card used for this payment. */ + creditCard?: Maybe +} + +/** An object representing a single payment. */ +export type Transaction = Node & { + __typename?: 'Transaction' + /** The ID of the object. */ + id: Scalars['ID'] + created: Scalars['DateTime'] + payment: Payment + token: Scalars['String'] + kind: TransactionKind + isSuccess: Scalars['Boolean'] + error?: Maybe + gatewayResponse: Scalars['JSONString'] + /** Total amount of the transaction. */ + amount?: Maybe +} + +/** An enumeration. */ +export enum TransactionKind { + /** External reference */ + External = 'EXTERNAL', + /** Authorization */ + Auth = 'AUTH', + /** Pending */ + Pending = 'PENDING', + /** Action to confirm */ + ActionToConfirm = 'ACTION_TO_CONFIRM', + /** Refund */ + Refund = 'REFUND', + /** Refund in progress */ + RefundOngoing = 'REFUND_ONGOING', + /** Capture */ + Capture = 'CAPTURE', + /** Void */ + Void = 'VOID', + /** Confirm */ + Confirm = 'CONFIRM', + /** Cancel */ + Cancel = 'CANCEL', +} + +export type CreditCard = { + __typename?: 'CreditCard' + /** Card brand. */ + brand: Scalars['String'] + /** First 4 digits of the card number. */ + firstDigits?: Maybe + /** Last 4 digits of the card number. */ + lastDigits: Scalars['String'] + /** Two-digit number representing the card’s expiration month. */ + expMonth?: Maybe + /** Four-digit number representing the card’s expiration year. */ + expYear?: Maybe +} + +/** History log of the order. */ +export type OrderEvent = Node & { + __typename?: 'OrderEvent' + /** The ID of the object. */ + id: Scalars['ID'] + /** Date when event happened at in ISO 8601 format. */ + date?: Maybe + /** Order event type. */ + type?: Maybe + /** User who performed the action. */ + user?: Maybe + /** Content of the event. */ + message?: Maybe + /** Email of the customer. */ + email?: Maybe + /** Type of an email sent to the customer. */ + emailType?: Maybe + /** Amount of money. */ + amount?: Maybe + /** The payment ID from the payment gateway. */ + paymentId?: Maybe + /** The payment gateway of the payment. */ + paymentGateway?: Maybe + /** Number of items. */ + quantity?: Maybe + /** Composed ID of the Fulfillment. */ + composedId?: Maybe + /** User-friendly number of an order. */ + orderNumber?: Maybe + /** Number of an invoice related to the order. */ + invoiceNumber?: Maybe + /** List of oversold lines names. */ + oversoldItems?: Maybe>> + /** The concerned lines. */ + lines?: Maybe>> + /** The lines fulfilled. */ + fulfilledItems?: Maybe>> + /** The warehouse were items were restocked. */ + warehouse?: Maybe + /** The transaction reference of captured payment. */ + transactionReference?: Maybe + /** Define if shipping costs were included to the refund. */ + shippingCostsIncluded?: Maybe + /** The order which is related to this order. */ + relatedOrder?: Maybe + /** The discount applied to the order. */ + discount?: Maybe +} + +/** An enumeration. */ +export enum OrderEventsEnum { + DraftCreated = 'DRAFT_CREATED', + DraftCreatedFromReplace = 'DRAFT_CREATED_FROM_REPLACE', + AddedProducts = 'ADDED_PRODUCTS', + RemovedProducts = 'REMOVED_PRODUCTS', + Placed = 'PLACED', + PlacedFromDraft = 'PLACED_FROM_DRAFT', + OversoldItems = 'OVERSOLD_ITEMS', + Canceled = 'CANCELED', + OrderMarkedAsPaid = 'ORDER_MARKED_AS_PAID', + OrderFullyPaid = 'ORDER_FULLY_PAID', + OrderReplacementCreated = 'ORDER_REPLACEMENT_CREATED', + OrderDiscountAdded = 'ORDER_DISCOUNT_ADDED', + OrderDiscountAutomaticallyUpdated = 'ORDER_DISCOUNT_AUTOMATICALLY_UPDATED', + OrderDiscountUpdated = 'ORDER_DISCOUNT_UPDATED', + OrderDiscountDeleted = 'ORDER_DISCOUNT_DELETED', + OrderLineDiscountUpdated = 'ORDER_LINE_DISCOUNT_UPDATED', + OrderLineDiscountRemoved = 'ORDER_LINE_DISCOUNT_REMOVED', + UpdatedAddress = 'UPDATED_ADDRESS', + EmailSent = 'EMAIL_SENT', + Confirmed = 'CONFIRMED', + PaymentAuthorized = 'PAYMENT_AUTHORIZED', + PaymentCaptured = 'PAYMENT_CAPTURED', + ExternalServiceNotification = 'EXTERNAL_SERVICE_NOTIFICATION', + PaymentRefunded = 'PAYMENT_REFUNDED', + PaymentVoided = 'PAYMENT_VOIDED', + PaymentFailed = 'PAYMENT_FAILED', + InvoiceRequested = 'INVOICE_REQUESTED', + InvoiceGenerated = 'INVOICE_GENERATED', + InvoiceUpdated = 'INVOICE_UPDATED', + InvoiceSent = 'INVOICE_SENT', + FulfillmentCanceled = 'FULFILLMENT_CANCELED', + FulfillmentRestockedItems = 'FULFILLMENT_RESTOCKED_ITEMS', + FulfillmentFulfilledItems = 'FULFILLMENT_FULFILLED_ITEMS', + FulfillmentRefunded = 'FULFILLMENT_REFUNDED', + FulfillmentReturned = 'FULFILLMENT_RETURNED', + FulfillmentReplaced = 'FULFILLMENT_REPLACED', + TrackingUpdated = 'TRACKING_UPDATED', + NoteAdded = 'NOTE_ADDED', + Other = 'OTHER', +} + +/** An enumeration. */ +export enum OrderEventsEmailsEnum { + PaymentConfirmation = 'PAYMENT_CONFIRMATION', + Confirmed = 'CONFIRMED', + ShippingConfirmation = 'SHIPPING_CONFIRMATION', + TrackingUpdated = 'TRACKING_UPDATED', + OrderConfirmation = 'ORDER_CONFIRMATION', + OrderCancel = 'ORDER_CANCEL', + OrderRefund = 'ORDER_REFUND', + FulfillmentConfirmation = 'FULFILLMENT_CONFIRMATION', + DigitalLinks = 'DIGITAL_LINKS', +} + +export type OrderEventOrderLineObject = { + __typename?: 'OrderEventOrderLineObject' + /** The variant quantity. */ + quantity?: Maybe + /** The order line. */ + orderLine?: Maybe + /** The variant name. */ + itemName?: Maybe + /** The discount applied to the order line. */ + discount?: Maybe +} + +export type OrderEventDiscountObject = { + __typename?: 'OrderEventDiscountObject' + /** Type of the discount: fixed or percent. */ + valueType: DiscountValueTypeEnum + /** Value of the discount. Can store fixed value or percent value. */ + value: Scalars['PositiveDecimal'] + /** Explanation for the applied discount. */ + reason?: Maybe + /** Returns amount of discount. */ + amount?: Maybe + /** Type of the discount: fixed or percent. */ + oldValueType?: Maybe + /** Value of the discount. Can store fixed value or percent value. */ + oldValue?: Maybe + /** Returns amount of discount. */ + oldAmount?: Maybe +} + +/** Contains all details related to the applied discount to the order. */ +export type OrderDiscount = Node & { + __typename?: 'OrderDiscount' + /** The ID of the object. */ + id: Scalars['ID'] + type: OrderDiscountType + /** Type of the discount: fixed or percent */ + valueType: DiscountValueTypeEnum + /** Value of the discount. Can store fixed value or percent value */ + value: Scalars['PositiveDecimal'] + name?: Maybe + translatedName?: Maybe + /** Explanation for the applied discount. */ + reason?: Maybe + /** Returns amount of discount. */ + amount: Money +} + +/** An enumeration. */ +export enum OrderDiscountType { + /** Voucher */ + Voucher = 'VOUCHER', + /** Manual */ + Manual = 'MANUAL', +} + +export type UserPermission = { + __typename?: 'UserPermission' + /** Internal code for permission. */ + code: PermissionEnum + /** Describe action(s) allowed to do by permission. */ + name: Scalars['String'] + /** List of user permission groups which contains this permission. */ + sourcePermissionGroups?: Maybe> +} + +export type UserPermissionSourcePermissionGroupsArgs = { + userId: Scalars['ID'] +} + +/** Represents permission group data. */ +export type Group = Node & { + __typename?: 'Group' + /** The ID of the object. */ + id: Scalars['ID'] + name: Scalars['String'] + /** List of group permissions */ + permissions?: Maybe>> + /** List of group users */ + users?: Maybe>> + /** True, if the currently authenticated user has rights to manage a group. */ + userCanManage: Scalars['Boolean'] +} + +/** History log of the customer. */ +export type CustomerEvent = Node & { + __typename?: 'CustomerEvent' + /** The ID of the object. */ + id: Scalars['ID'] + /** Date when event happened at in ISO 8601 format. */ + date?: Maybe + /** Customer event type. */ + type?: Maybe + /** User who performed the action. */ + user?: Maybe + /** Content of the event. */ + message?: Maybe + /** Number of objects concerned by the event. */ + count?: Maybe + /** The concerned order. */ + order?: Maybe + /** The concerned order line. */ + orderLine?: Maybe +} + +/** An enumeration. */ +export enum CustomerEventsEnum { + AccountCreated = 'ACCOUNT_CREATED', + PasswordResetLinkSent = 'PASSWORD_RESET_LINK_SENT', + PasswordReset = 'PASSWORD_RESET', + EmailChangedRequest = 'EMAIL_CHANGED_REQUEST', + PasswordChanged = 'PASSWORD_CHANGED', + EmailChanged = 'EMAIL_CHANGED', + PlacedOrder = 'PLACED_ORDER', + NoteAddedToOrder = 'NOTE_ADDED_TO_ORDER', + DigitalLinkDownloaded = 'DIGITAL_LINK_DOWNLOADED', + CustomerDeleted = 'CUSTOMER_DELETED', + NameAssigned = 'NAME_ASSIGNED', + EmailAssigned = 'EMAIL_ASSIGNED', + NoteAdded = 'NOTE_ADDED', +} + +/** Represents a payment source stored for user in payment gateway, such as credit card. */ +export type PaymentSource = { + __typename?: 'PaymentSource' + /** Payment gateway name. */ + gateway: Scalars['String'] + /** Stored credit card details if available. */ + creditCardInfo?: Maybe +} + +export type LimitInfo = { + __typename?: 'LimitInfo' + /** Defines the current resource usage. */ + currentUsage: Limits + /** Defines the allowed maximum resource usage, null means unlimited. */ + allowedUsage: Limits +} + +export type Limits = { + __typename?: 'Limits' + channels?: Maybe + orders?: Maybe + productVariants?: Maybe + staffUsers?: Maybe + warehouses?: Maybe +} + +/** Order related settings from site settings. */ +export type OrderSettings = { + __typename?: 'OrderSettings' + automaticallyConfirmAllNewOrders: Scalars['Boolean'] +} + +export type ShippingZoneFilterInput = { + search?: Maybe +} + +export type DigitalContentCountableConnection = { + __typename?: 'DigitalContentCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type DigitalContentCountableEdge = { + __typename?: 'DigitalContentCountableEdge' + /** The item at the end of the edge. */ + node: DigitalContent + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type CategoryFilterInput = { + search?: Maybe + metadata?: Maybe>> + ids?: Maybe>> +} + +export type CategorySortingInput = { + /** Specifies the direction in which to sort products. */ + direction: OrderDirection + /** Specifies the channel in which to sort the data. */ + channel?: Maybe + /** Sort categories by the selected field. */ + field: CategorySortField +} + +export enum CategorySortField { + /** Sort categories by name. */ + Name = 'NAME', + /** Sort categories by product count. */ + ProductCount = 'PRODUCT_COUNT', + /** Sort categories by subcategory count. */ + SubcategoryCount = 'SUBCATEGORY_COUNT', +} + +export type CollectionFilterInput = { + published?: Maybe + search?: Maybe + metadata?: Maybe>> + ids?: Maybe>> + /** Specifies the channel by which the data should be sorted. */ + channel?: Maybe +} + +export enum CollectionPublished { + Published = 'PUBLISHED', + Hidden = 'HIDDEN', +} + +export type CollectionSortingInput = { + /** Specifies the direction in which to sort products. */ + direction: OrderDirection + /** Specifies the channel in which to sort the data. */ + channel?: Maybe + /** Sort collections by the selected field. */ + field: CollectionSortField +} + +export enum CollectionSortField { + /** Sort collections by name. */ + Name = 'NAME', + /** Sort collections by availability. */ + Availability = 'AVAILABILITY', + /** Sort collections by product count. */ + ProductCount = 'PRODUCT_COUNT', + /** Sort collections by publication date. */ + PublicationDate = 'PUBLICATION_DATE', +} + +export type ProductTypeFilterInput = { + search?: Maybe + configurable?: Maybe + productType?: Maybe + metadata?: Maybe>> + ids?: Maybe>> +} + +export enum ProductTypeConfigurable { + Configurable = 'CONFIGURABLE', + Simple = 'SIMPLE', +} + +export enum ProductTypeEnum { + Digital = 'DIGITAL', + Shippable = 'SHIPPABLE', +} + +export type ProductTypeSortingInput = { + /** Specifies the direction in which to sort products. */ + direction: OrderDirection + /** Sort product types by the selected field. */ + field: ProductTypeSortField +} + +export enum ProductTypeSortField { + /** Sort products by name. */ + Name = 'NAME', + /** Sort products by type. */ + Digital = 'DIGITAL', + /** Sort products by shipping. */ + ShippingRequired = 'SHIPPING_REQUIRED', +} + +export type ProductVariantCountableConnection = { + __typename?: 'ProductVariantCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type ProductVariantCountableEdge = { + __typename?: 'ProductVariantCountableEdge' + /** The item at the end of the edge. */ + node: ProductVariant + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type ProductVariantFilterInput = { + search?: Maybe + sku?: Maybe>> + metadata?: Maybe>> +} + +export type PaymentCountableConnection = { + __typename?: 'PaymentCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type PaymentCountableEdge = { + __typename?: 'PaymentCountableEdge' + /** The item at the end of the edge. */ + node: Payment + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type PaymentFilterInput = { + checkouts?: Maybe>> +} + +export type PageCountableConnection = { + __typename?: 'PageCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type PageCountableEdge = { + __typename?: 'PageCountableEdge' + /** The item at the end of the edge. */ + node: Page + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type PageSortingInput = { + /** Specifies the direction in which to sort products. */ + direction: OrderDirection + /** Sort pages by the selected field. */ + field: PageSortField +} + +export enum PageSortField { + /** Sort pages by title. */ + Title = 'TITLE', + /** Sort pages by slug. */ + Slug = 'SLUG', + /** Sort pages by visibility. */ + Visibility = 'VISIBILITY', + /** Sort pages by creation date. */ + CreationDate = 'CREATION_DATE', + /** Sort pages by publication date. */ + PublicationDate = 'PUBLICATION_DATE', +} + +export type PageFilterInput = { + search?: Maybe + metadata?: Maybe>> +} + +export type PageTypeCountableConnection = { + __typename?: 'PageTypeCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type PageTypeCountableEdge = { + __typename?: 'PageTypeCountableEdge' + /** The item at the end of the edge. */ + node: PageType + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type PageTypeSortingInput = { + /** Specifies the direction in which to sort products. */ + direction: OrderDirection + /** Sort page types by the selected field. */ + field: PageTypeSortField +} + +export enum PageTypeSortField { + /** Sort page types by name. */ + Name = 'NAME', + /** Sort page types by slug. */ + Slug = 'SLUG', +} + +export type PageTypeFilterInput = { + search?: Maybe +} + +export type OrderEventCountableConnection = { + __typename?: 'OrderEventCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type OrderEventCountableEdge = { + __typename?: 'OrderEventCountableEdge' + /** The item at the end of the edge. */ + node: OrderEvent + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type OrderSortingInput = { + /** Specifies the direction in which to sort products. */ + direction: OrderDirection + /** Sort orders by the selected field. */ + field: OrderSortField +} + +export enum OrderSortField { + /** Sort orders by number. */ + Number = 'NUMBER', + /** Sort orders by creation date. */ + CreationDate = 'CREATION_DATE', + /** Sort orders by customer. */ + Customer = 'CUSTOMER', + /** Sort orders by payment. */ + Payment = 'PAYMENT', + /** Sort orders by fulfillment status. */ + FulfillmentStatus = 'FULFILLMENT_STATUS', +} + +export type OrderFilterInput = { + paymentStatus?: Maybe>> + status?: Maybe>> + customer?: Maybe + created?: Maybe + search?: Maybe + metadata?: Maybe>> + channels?: Maybe>> +} + +export enum OrderStatusFilter { + ReadyToFulfill = 'READY_TO_FULFILL', + ReadyToCapture = 'READY_TO_CAPTURE', + Unfulfilled = 'UNFULFILLED', + Unconfirmed = 'UNCONFIRMED', + PartiallyFulfilled = 'PARTIALLY_FULFILLED', + Fulfilled = 'FULFILLED', + Canceled = 'CANCELED', +} + +export type DateRangeInput = { + /** Start date. */ + gte?: Maybe + /** End date. */ + lte?: Maybe +} + +export type OrderDraftFilterInput = { + customer?: Maybe + created?: Maybe + search?: Maybe + metadata?: Maybe>> + channels?: Maybe>> +} + +export type MenuCountableConnection = { + __typename?: 'MenuCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type MenuCountableEdge = { + __typename?: 'MenuCountableEdge' + /** The item at the end of the edge. */ + node: Menu + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type MenuSortingInput = { + /** Specifies the direction in which to sort products. */ + direction: OrderDirection + /** Sort menus by the selected field. */ + field: MenuSortField +} + +export enum MenuSortField { + /** Sort menus by name. */ + Name = 'NAME', + /** Sort menus by items count. */ + ItemsCount = 'ITEMS_COUNT', +} + +export type MenuFilterInput = { + search?: Maybe + slug?: Maybe>> + metadata?: Maybe>> +} + +export type MenuItemCountableConnection = { + __typename?: 'MenuItemCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type MenuItemCountableEdge = { + __typename?: 'MenuItemCountableEdge' + /** The item at the end of the edge. */ + node: MenuItem + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type MenuItemSortingInput = { + /** Specifies the direction in which to sort products. */ + direction: OrderDirection + /** Sort menu items by the selected field. */ + field: MenuItemsSortField +} + +export enum MenuItemsSortField { + /** Sort menu items by name. */ + Name = 'NAME', +} + +export type MenuItemFilterInput = { + search?: Maybe + metadata?: Maybe>> +} + +/** Plugin. */ +export type Plugin = Node & { + __typename?: 'Plugin' + id: Scalars['ID'] + name: Scalars['String'] + description: Scalars['String'] + active: Scalars['Boolean'] + configuration?: Maybe>> +} + +/** Stores information about a single configuration field. */ +export type ConfigurationItem = { + __typename?: 'ConfigurationItem' + /** Name of the field. */ + name: Scalars['String'] + /** Current value of the field. */ + value?: Maybe + /** Type of the field. */ + type?: Maybe + /** Help text for the field. */ + helpText?: Maybe + /** Label for the field. */ + label?: Maybe +} + +/** An enumeration. */ +export enum ConfigurationTypeFieldEnum { + String = 'STRING', + Multiline = 'MULTILINE', + Boolean = 'BOOLEAN', + Secret = 'SECRET', + Password = 'PASSWORD', + Secretmultiline = 'SECRETMULTILINE', +} + +export type PluginCountableConnection = { + __typename?: 'PluginCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type PluginCountableEdge = { + __typename?: 'PluginCountableEdge' + /** The item at the end of the edge. */ + node: Plugin + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type PluginFilterInput = { + active?: Maybe + search?: Maybe +} + +export type PluginSortingInput = { + /** Specifies the direction in which to sort products. */ + direction: OrderDirection + /** Sort plugins by the selected field. */ + field: PluginSortField +} + +export enum PluginSortField { + Name = 'NAME', + IsActive = 'IS_ACTIVE', +} + +export type SaleCountableConnection = { + __typename?: 'SaleCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type SaleCountableEdge = { + __typename?: 'SaleCountableEdge' + /** The item at the end of the edge. */ + node: Sale + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type SaleFilterInput = { + status?: Maybe>> + saleType?: Maybe + started?: Maybe + search?: Maybe +} + +export enum DiscountStatusEnum { + Active = 'ACTIVE', + Expired = 'EXPIRED', + Scheduled = 'SCHEDULED', +} + +export type DateTimeRangeInput = { + /** Start date. */ + gte?: Maybe + /** End date. */ + lte?: Maybe +} + +export type SaleSortingInput = { + /** Specifies the direction in which to sort products. */ + direction: OrderDirection + /** Specifies the channel in which to sort the data. */ + channel?: Maybe + /** Sort sales by the selected field. */ + field: SaleSortField +} + +export enum SaleSortField { + /** Sort sales by name. */ + Name = 'NAME', + /** Sort sales by start date. */ + StartDate = 'START_DATE', + /** Sort sales by end date. */ + EndDate = 'END_DATE', + /** Sort sales by value. */ + Value = 'VALUE', + /** Sort sales by type. */ + Type = 'TYPE', +} + +export type VoucherCountableConnection = { + __typename?: 'VoucherCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type VoucherCountableEdge = { + __typename?: 'VoucherCountableEdge' + /** The item at the end of the edge. */ + node: Voucher + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type VoucherFilterInput = { + status?: Maybe>> + timesUsed?: Maybe + discountType?: Maybe>> + started?: Maybe + search?: Maybe +} + +export enum VoucherDiscountType { + Fixed = 'FIXED', + Percentage = 'PERCENTAGE', + Shipping = 'SHIPPING', +} + +export type VoucherSortingInput = { + /** Specifies the direction in which to sort products. */ + direction: OrderDirection + /** Specifies the channel in which to sort the data. */ + channel?: Maybe + /** Sort vouchers by the selected field. */ + field: VoucherSortField +} + +export enum VoucherSortField { + /** Sort vouchers by code. */ + Code = 'CODE', + /** Sort vouchers by start date. */ + StartDate = 'START_DATE', + /** Sort vouchers by end date. */ + EndDate = 'END_DATE', + /** Sort vouchers by value. */ + Value = 'VALUE', + /** Sort vouchers by type. */ + Type = 'TYPE', + /** Sort vouchers by usage limit. */ + UsageLimit = 'USAGE_LIMIT', + /** Sort vouchers by minimum spent amount. */ + MinimumSpentAmount = 'MINIMUM_SPENT_AMOUNT', +} + +/** Represents a job data of exported file. */ +export type ExportFile = Node & + Job & { + __typename?: 'ExportFile' + /** The ID of the object. */ + id: Scalars['ID'] + user?: Maybe + app?: Maybe + /** Job status. */ + status: JobStatusEnum + /** Created date time of job in ISO 8601 format. */ + createdAt: Scalars['DateTime'] + /** Date time of job last update in ISO 8601 format. */ + updatedAt: Scalars['DateTime'] + /** Job message. */ + message?: Maybe + /** The URL of field to download. */ + url?: Maybe + /** List of events associated with the export. */ + events?: Maybe> + } + +/** History log of export file. */ +export type ExportEvent = Node & { + __typename?: 'ExportEvent' + /** The ID of the object. */ + id: Scalars['ID'] + /** Date when event happened at in ISO 8601 format. */ + date: Scalars['DateTime'] + /** Export event type. */ + type: ExportEventsEnum + /** User who performed the action. */ + user?: Maybe + /** App which performed the action. */ + app?: Maybe + /** Content of the event. */ + message: Scalars['String'] +} + +/** An enumeration. */ +export enum ExportEventsEnum { + ExportPending = 'EXPORT_PENDING', + ExportSuccess = 'EXPORT_SUCCESS', + ExportFailed = 'EXPORT_FAILED', + ExportDeleted = 'EXPORT_DELETED', + ExportedFileSent = 'EXPORTED_FILE_SENT', + ExportFailedInfoSent = 'EXPORT_FAILED_INFO_SENT', +} + +export type ExportFileCountableConnection = { + __typename?: 'ExportFileCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type ExportFileCountableEdge = { + __typename?: 'ExportFileCountableEdge' + /** The item at the end of the edge. */ + node: ExportFile + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type ExportFileFilterInput = { + createdAt?: Maybe + updatedAt?: Maybe + status?: Maybe + user?: Maybe + app?: Maybe +} + +export type ExportFileSortingInput = { + /** Specifies the direction in which to sort products. */ + direction: OrderDirection + /** Sort export file by the selected field. */ + field: ExportFileSortField +} + +export enum ExportFileSortField { + /** Sort export file by status. */ + Status = 'STATUS', + /** Sort export file by created at. */ + CreatedAt = 'CREATED_AT', + /** Sort export file by updated at. */ + UpdatedAt = 'UPDATED_AT', +} + +export type CheckoutCountableConnection = { + __typename?: 'CheckoutCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type CheckoutCountableEdge = { + __typename?: 'CheckoutCountableEdge' + /** The item at the end of the edge. */ + node: Checkout + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type CheckoutLineCountableConnection = { + __typename?: 'CheckoutLineCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type CheckoutLineCountableEdge = { + __typename?: 'CheckoutLineCountableEdge' + /** The item at the end of the edge. */ + node: CheckoutLine + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type AttributeSortingInput = { + /** Specifies the direction in which to sort products. */ + direction: OrderDirection + /** Sort attributes by the selected field. */ + field: AttributeSortField +} + +export enum AttributeSortField { + /** Sort attributes by name */ + Name = 'NAME', + /** Sort attributes by slug */ + Slug = 'SLUG', + /** Sort attributes by the value required flag */ + ValueRequired = 'VALUE_REQUIRED', + /** Sort attributes by the variant only flag */ + IsVariantOnly = 'IS_VARIANT_ONLY', + /** Sort attributes by visibility in the storefront */ + VisibleInStorefront = 'VISIBLE_IN_STOREFRONT', + /** Sort attributes by the filterable in storefront flag */ + FilterableInStorefront = 'FILTERABLE_IN_STOREFRONT', + /** Sort attributes by the filterable in dashboard flag */ + FilterableInDashboard = 'FILTERABLE_IN_DASHBOARD', + /** Sort attributes by their position in storefront */ + StorefrontSearchPosition = 'STOREFRONT_SEARCH_POSITION', + /** Sort attributes based on whether they can be displayed or not in a product grid. */ + AvailableInGrid = 'AVAILABLE_IN_GRID', +} + +/** Represents ongoing installation of app. */ +export type AppInstallation = Node & + Job & { + __typename?: 'AppInstallation' + appName: Scalars['String'] + manifestUrl: Scalars['String'] + /** The ID of the object. */ + id: Scalars['ID'] + /** Job status. */ + status: JobStatusEnum + /** Created date time of job in ISO 8601 format. */ + createdAt: Scalars['DateTime'] + /** Date time of job last update in ISO 8601 format. */ + updatedAt: Scalars['DateTime'] + /** Job message. */ + message?: Maybe + } + +export type AppCountableConnection = { + __typename?: 'AppCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type AppCountableEdge = { + __typename?: 'AppCountableEdge' + /** The item at the end of the edge. */ + node: App + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type AppFilterInput = { + search?: Maybe + isActive?: Maybe + type?: Maybe +} + +export type AppSortingInput = { + /** Specifies the direction in which to sort products. */ + direction: OrderDirection + /** Sort apps by the selected field. */ + field: AppSortField +} + +export enum AppSortField { + /** Sort apps by name. */ + Name = 'NAME', + /** Sort apps by creation date. */ + CreationDate = 'CREATION_DATE', +} + +export type AddressValidationData = { + __typename?: 'AddressValidationData' + countryCode?: Maybe + countryName?: Maybe + addressFormat?: Maybe + addressLatinFormat?: Maybe + allowedFields?: Maybe>> + requiredFields?: Maybe>> + upperFields?: Maybe>> + countryAreaType?: Maybe + countryAreaChoices?: Maybe>> + cityType?: Maybe + cityChoices?: Maybe>> + cityAreaType?: Maybe + cityAreaChoices?: Maybe>> + postalCodeType?: Maybe + postalCodeMatchers?: Maybe>> + postalCodeExamples?: Maybe>> + postalCodePrefix?: Maybe +} + +export type ChoiceValue = { + __typename?: 'ChoiceValue' + raw?: Maybe + verbose?: Maybe +} + +export type UserCountableConnection = { + __typename?: 'UserCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type UserCountableEdge = { + __typename?: 'UserCountableEdge' + /** The item at the end of the edge. */ + node: User + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type CustomerFilterInput = { + dateJoined?: Maybe + numberOfOrders?: Maybe + placedOrders?: Maybe + search?: Maybe +} + +export type UserSortingInput = { + /** Specifies the direction in which to sort products. */ + direction: OrderDirection + /** Sort users by the selected field. */ + field: UserSortField +} + +export enum UserSortField { + /** Sort users by first name. */ + FirstName = 'FIRST_NAME', + /** Sort users by last name. */ + LastName = 'LAST_NAME', + /** Sort users by email. */ + Email = 'EMAIL', + /** Sort users by order count. */ + OrderCount = 'ORDER_COUNT', +} + +export type GroupCountableConnection = { + __typename?: 'GroupCountableConnection' + /** Pagination data for this connection. */ + pageInfo: PageInfo + edges: Array + /** A total count of items in the collection. */ + totalCount?: Maybe +} + +export type GroupCountableEdge = { + __typename?: 'GroupCountableEdge' + /** The item at the end of the edge. */ + node: Group + /** A cursor for use in pagination. */ + cursor: Scalars['String'] +} + +export type PermissionGroupFilterInput = { + search?: Maybe +} + +export type PermissionGroupSortingInput = { + /** Specifies the direction in which to sort products. */ + direction: OrderDirection + /** Sort permission group by the selected field. */ + field: PermissionGroupSortField +} + +export enum PermissionGroupSortField { + /** Sort permission group accounts by name. */ + Name = 'NAME', +} + +export type StaffUserInput = { + status?: Maybe + search?: Maybe +} + +export enum StaffMemberStatus { + /** User account has been activated. */ + Active = 'ACTIVE', + /** User account has not been activated yet. */ + Deactivated = 'DEACTIVATED', +} + +export type _Entity = + | Address + | User + | Group + | App + | ProductVariant + | Product + | ProductType + | Collection + | Category + | ProductMedia + | ProductImage + | PageType + +export type _Service = { + __typename?: '_Service' + sdl?: Maybe +} + export type Mutation = { __typename?: 'Mutation' - /** - * Updates the attributes of a checkout. - * @deprecated Use `checkoutAttributesUpdateV2` instead - */ - checkoutAttributesUpdate?: Maybe - /** Updates the attributes of a checkout. */ - checkoutAttributesUpdateV2?: Maybe - /** Completes a checkout without providing payment information. You can use this mutation for free items or items whose purchase price is covered by a gift card. */ - checkoutCompleteFree?: Maybe - /** - * Completes a checkout using a credit card token from Shopify's Vault. - * @deprecated Use `checkoutCompleteWithCreditCardV2` instead - */ - checkoutCompleteWithCreditCard?: Maybe - /** Completes a checkout using a credit card token from Shopify's card vault. Before you can complete checkouts using CheckoutCompleteWithCreditCardV2, you need to [_request payment processing_](https://help.shopify.com/api/guides/sales-channel-sdk/getting-started#request-payment-processing). */ - checkoutCompleteWithCreditCardV2?: Maybe - /** - * Completes a checkout with a tokenized payment. - * @deprecated Use `checkoutCompleteWithTokenizedPaymentV2` instead - */ - checkoutCompleteWithTokenizedPayment?: Maybe - /** - * Completes a checkout with a tokenized payment. - * @deprecated Use `checkoutCompleteWithTokenizedPaymentV3` instead - */ - checkoutCompleteWithTokenizedPaymentV2?: Maybe - /** Completes a checkout with a tokenized payment. */ - checkoutCompleteWithTokenizedPaymentV3?: Maybe - /** Creates a new checkout. */ - checkoutCreate?: Maybe - /** - * Associates a customer to the checkout. - * @deprecated Use `checkoutCustomerAssociateV2` instead - */ - checkoutCustomerAssociate?: Maybe - /** Associates a customer to the checkout. */ - checkoutCustomerAssociateV2?: Maybe - /** - * Disassociates the current checkout customer from the checkout. - * @deprecated Use `checkoutCustomerDisassociateV2` instead - */ - checkoutCustomerDisassociate?: Maybe - /** Disassociates the current checkout customer from the checkout. */ - checkoutCustomerDisassociateV2?: Maybe - /** - * Applies a discount to an existing checkout using a discount code. - * @deprecated Use `checkoutDiscountCodeApplyV2` instead - */ - checkoutDiscountCodeApply?: Maybe - /** Applies a discount to an existing checkout using a discount code. */ - checkoutDiscountCodeApplyV2?: Maybe - /** Removes the applied discount from an existing checkout. */ - checkoutDiscountCodeRemove?: Maybe - /** - * Updates the email on an existing checkout. - * @deprecated Use `checkoutEmailUpdateV2` instead - */ - checkoutEmailUpdate?: Maybe - /** Updates the email on an existing checkout. */ - checkoutEmailUpdateV2?: Maybe - /** - * Applies a gift card to an existing checkout using a gift card code. This will replace all currently applied gift cards. - * @deprecated Use `checkoutGiftCardsAppend` instead - */ - checkoutGiftCardApply?: Maybe - /** - * Removes an applied gift card from the checkout. - * @deprecated Use `checkoutGiftCardRemoveV2` instead - */ - checkoutGiftCardRemove?: Maybe - /** Removes an applied gift card from the checkout. */ - checkoutGiftCardRemoveV2?: Maybe - /** Appends gift cards to an existing checkout. */ - checkoutGiftCardsAppend?: Maybe - /** Adds a list of line items to a checkout. */ - checkoutLineItemsAdd?: Maybe - /** Removes line items from an existing checkout. */ - checkoutLineItemsRemove?: Maybe - /** Sets a list of line items to a checkout. */ - checkoutLineItemsReplace?: Maybe - /** Updates line items on a checkout. */ - checkoutLineItemsUpdate?: Maybe - /** - * Updates the shipping address of an existing checkout. - * @deprecated Use `checkoutShippingAddressUpdateV2` instead - */ - checkoutShippingAddressUpdate?: Maybe - /** Updates the shipping address of an existing checkout. */ - checkoutShippingAddressUpdateV2?: Maybe - /** Updates the shipping lines on an existing checkout. */ - checkoutShippingLineUpdate?: Maybe - /** - * Creates a customer access token. - * The customer access token is required to modify the customer object in any way. - */ - customerAccessTokenCreate?: Maybe - /** - * Creates a customer access token using a multipass token instead of email and password. - * A customer record is created if customer does not exist. If a customer record already - * exists but the record is disabled, then it's enabled. - */ - customerAccessTokenCreateWithMultipass?: Maybe - /** Permanently destroys a customer access token. */ - customerAccessTokenDelete?: Maybe - /** - * Renews a customer access token. - * - * Access token renewal must happen *before* a token expires. - * If a token has already expired, a new one should be created instead via `customerAccessTokenCreate`. - */ - customerAccessTokenRenew?: Maybe - /** Activates a customer. */ - customerActivate?: Maybe - /** Activates a customer with the activation url received from `customerCreate`. */ - customerActivateByUrl?: Maybe - /** Creates a new address for a customer. */ - customerAddressCreate?: Maybe - /** Permanently deletes the address of an existing customer. */ - customerAddressDelete?: Maybe - /** Updates the address of an existing customer. */ - customerAddressUpdate?: Maybe + /** Creates a new webhook subscription. */ + webhookCreate?: Maybe + /** Deletes a webhook subscription. */ + webhookDelete?: Maybe + /** Updates a webhook subscription. */ + webhookUpdate?: Maybe + /** Creates new warehouse. */ + createWarehouse?: Maybe + /** Updates given warehouse. */ + updateWarehouse?: Maybe + /** Deletes selected warehouse. */ + deleteWarehouse?: Maybe + /** Add shipping zone to given warehouse. */ + assignWarehouseShippingZone?: Maybe + /** Remove shipping zone from given warehouse. */ + unassignWarehouseShippingZone?: Maybe + /** Creates a new staff notification recipient. */ + staffNotificationRecipientCreate?: Maybe + /** Updates a staff notification recipient. */ + staffNotificationRecipientUpdate?: Maybe + /** Delete staff notification recipient. */ + staffNotificationRecipientDelete?: Maybe + /** Updates site domain of the shop. */ + shopDomainUpdate?: Maybe + /** Updates shop settings. */ + shopSettingsUpdate?: Maybe + /** Fetch tax rates. */ + shopFetchTaxRates?: Maybe + /** Creates/Updates translations for Shop Settings. */ + shopSettingsTranslate?: Maybe + /** Update the shop's address. If the `null` value is passed, the currently selected address will be deleted. */ + shopAddressUpdate?: Maybe + /** Update shop order settings. */ + orderSettingsUpdate?: Maybe + /** Manage shipping method's availability in channels. */ + shippingMethodChannelListingUpdate?: Maybe + /** Creates a new shipping price. */ + shippingPriceCreate?: Maybe + /** Deletes a shipping price. */ + shippingPriceDelete?: Maybe + /** Deletes shipping prices. */ + shippingPriceBulkDelete?: Maybe + /** Updates a new shipping price. */ + shippingPriceUpdate?: Maybe + /** Creates/Updates translations for shipping method. */ + shippingPriceTranslate?: Maybe + /** Exclude products from shipping price. */ + shippingPriceExcludeProducts?: Maybe + /** Remove product from excluded list for shipping price. */ + shippingPriceRemoveProductFromExclude?: Maybe + /** Creates a new shipping zone. */ + shippingZoneCreate?: Maybe + /** Deletes a shipping zone. */ + shippingZoneDelete?: Maybe + /** Deletes shipping zones. */ + shippingZoneBulkDelete?: Maybe + /** Updates a new shipping zone. */ + shippingZoneUpdate?: Maybe + /** Assign attributes to a given product type. */ + productAttributeAssign?: Maybe + /** Un-assign attributes from a given product type. */ + productAttributeUnassign?: Maybe + /** Creates a new category. */ + categoryCreate?: Maybe + /** Deletes a category. */ + categoryDelete?: Maybe + /** Deletes categories. */ + categoryBulkDelete?: Maybe + /** Updates a category. */ + categoryUpdate?: Maybe + /** Creates/Updates translations for Category. */ + categoryTranslate?: Maybe + /** Adds products to a collection. */ + collectionAddProducts?: Maybe + /** Creates a new collection. */ + collectionCreate?: Maybe + /** Deletes a collection. */ + collectionDelete?: Maybe + /** Reorder the products of a collection. */ + collectionReorderProducts?: Maybe + /** Deletes collections. */ + collectionBulkDelete?: Maybe + /** Remove products from a collection. */ + collectionRemoveProducts?: Maybe + /** Updates a collection. */ + collectionUpdate?: Maybe + /** Creates/Updates translations for collection. */ + collectionTranslate?: Maybe + /** Manage collection's availability in channels. */ + collectionChannelListingUpdate?: Maybe + /** Creates a new product. */ + productCreate?: Maybe + /** Deletes a product. */ + productDelete?: Maybe + /** Deletes products. */ + productBulkDelete?: Maybe + /** Updates an existing product. */ + productUpdate?: Maybe + /** Creates/Updates translations for Product. */ + productTranslate?: Maybe + /** Manage product's availability in channels. */ + productChannelListingUpdate?: Maybe + /** Create a media object (image or video URL) associated with product. For image, this mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec */ + productMediaCreate?: Maybe + /** Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook. */ + productVariantReorder?: Maybe + /** Deletes a product media. */ + productMediaDelete?: Maybe + /** Deletes product media. */ + productMediaBulkDelete?: Maybe + /** Changes ordering of the product media. */ + productMediaReorder?: Maybe + /** Updates a product media. */ + productMediaUpdate?: Maybe + /** Creates a new product type. */ + productTypeCreate?: Maybe + /** Deletes a product type. */ + productTypeDelete?: Maybe + /** Deletes product types. */ + productTypeBulkDelete?: Maybe + /** Updates an existing product type. */ + productTypeUpdate?: Maybe + /** Reorder the attributes of a product type. */ + productTypeReorderAttributes?: Maybe + /** Reorder product attribute values. */ + productReorderAttributeValues?: Maybe + /** Create new digital content. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec */ + digitalContentCreate?: Maybe + /** Remove digital content assigned to given variant. */ + digitalContentDelete?: Maybe + /** Update digital content. */ + digitalContentUpdate?: Maybe + /** Generate new URL to digital content. */ + digitalContentUrlCreate?: Maybe + /** Creates a new variant for a product. */ + productVariantCreate?: Maybe + /** Deletes a product variant. */ + productVariantDelete?: Maybe + /** Creates product variants for a given product. */ + productVariantBulkCreate?: Maybe + /** Deletes product variants. */ + productVariantBulkDelete?: Maybe + /** Creates stocks for product variant. */ + productVariantStocksCreate?: Maybe + /** Delete stocks from product variant. */ + productVariantStocksDelete?: Maybe + /** Update stocks for product variant. */ + productVariantStocksUpdate?: Maybe + /** Updates an existing variant for product. */ + productVariantUpdate?: Maybe + /** Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook. */ + productVariantSetDefault?: Maybe + /** Creates/Updates translations for Product Variant. */ + productVariantTranslate?: Maybe + /** Manage product variant prices in channels. */ + productVariantChannelListingUpdate?: Maybe + /** Reorder product variant attribute values. */ + productVariantReorderAttributeValues?: Maybe + /** Assign an media to a product variant. */ + variantMediaAssign?: Maybe + /** Unassign an media from a product variant. */ + variantMediaUnassign?: Maybe + /** Captures the authorized payment amount. */ + paymentCapture?: Maybe + /** Refunds the captured payment amount. */ + paymentRefund?: Maybe + /** Voids the authorized payment. */ + paymentVoid?: Maybe + /** Initializes payment process when it is required by gateway. */ + paymentInitialize?: Maybe + /** Creates a new page. */ + pageCreate?: Maybe + /** Deletes a page. */ + pageDelete?: Maybe + /** Deletes pages. */ + pageBulkDelete?: Maybe + /** Publish pages. */ + pageBulkPublish?: Maybe + /** Updates an existing page. */ + pageUpdate?: Maybe + /** Creates/Updates translations for Page. */ + pageTranslate?: Maybe + /** Create a new page type. */ + pageTypeCreate?: Maybe + /** Update page type. */ + pageTypeUpdate?: Maybe + /** Delete a page type. */ + pageTypeDelete?: Maybe + /** Delete page types. */ + pageTypeBulkDelete?: Maybe + /** Assign attributes to a given page type. */ + pageAttributeAssign?: Maybe + /** Unassign attributes from a given page type. */ + pageAttributeUnassign?: Maybe + /** Reorder the attributes of a page type. */ + pageTypeReorderAttributes?: Maybe + /** Reorder page attribute values. */ + pageReorderAttributeValues?: Maybe + /** Completes creating an order. */ + draftOrderComplete?: Maybe + /** Creates a new draft order. */ + draftOrderCreate?: Maybe + /** Deletes a draft order. */ + draftOrderDelete?: Maybe + /** Deletes draft orders. */ + draftOrderBulkDelete?: Maybe + /** Deletes order lines. */ + draftOrderLinesBulkDelete?: Maybe + /** Updates a draft order. */ + draftOrderUpdate?: Maybe + /** Adds note to the order. */ + orderAddNote?: Maybe + /** Cancel an order. */ + orderCancel?: Maybe + /** Capture an order. */ + orderCapture?: Maybe + /** Confirms an unconfirmed order by changing status to unfulfilled. */ + orderConfirm?: Maybe + /** Creates new fulfillments for an order. */ + orderFulfill?: Maybe + /** Cancels existing fulfillment and optionally restocks items. */ + orderFulfillmentCancel?: Maybe + /** Updates a fulfillment for an order. */ + orderFulfillmentUpdateTracking?: Maybe + /** Refund products. */ + orderFulfillmentRefundProducts?: Maybe + /** Return products. */ + orderFulfillmentReturnProducts?: Maybe + /** Create order lines for an order. */ + orderLinesCreate?: Maybe + /** Deletes an order line from an order. */ + orderLineDelete?: Maybe + /** Updates an order line of an order. */ + orderLineUpdate?: Maybe + /** Adds discount to the order. */ + orderDiscountAdd?: Maybe + /** Update discount for the order. */ + orderDiscountUpdate?: Maybe + /** Remove discount from the order. */ + orderDiscountDelete?: Maybe + /** Update discount for the order line. */ + orderLineDiscountUpdate?: Maybe + /** Remove discount applied to the order line. */ + orderLineDiscountRemove?: Maybe + /** Mark order as manually paid. */ + orderMarkAsPaid?: Maybe + /** Refund an order. */ + orderRefund?: Maybe + /** Updates an order. */ + orderUpdate?: Maybe + /** Updates a shipping method of the order. */ + orderUpdateShipping?: Maybe + /** Void an order. */ + orderVoid?: Maybe + /** Cancels orders. */ + orderBulkCancel?: Maybe + /** Delete metadata of an object. */ + deleteMetadata?: Maybe + /** Delete object's private metadata. */ + deletePrivateMetadata?: Maybe + /** Updates metadata of an object. */ + updateMetadata?: Maybe + /** Updates private metadata of an object. */ + updatePrivateMetadata?: Maybe + /** Assigns storefront's navigation menus. */ + assignNavigation?: Maybe + /** Creates a new Menu. */ + menuCreate?: Maybe + /** Deletes a menu. */ + menuDelete?: Maybe + /** Deletes menus. */ + menuBulkDelete?: Maybe + /** Updates a menu. */ + menuUpdate?: Maybe + /** Creates a new menu item. */ + menuItemCreate?: Maybe + /** Deletes a menu item. */ + menuItemDelete?: Maybe + /** Deletes menu items. */ + menuItemBulkDelete?: Maybe + /** Updates a menu item. */ + menuItemUpdate?: Maybe + /** Creates/Updates translations for Menu Item. */ + menuItemTranslate?: Maybe + /** Moves items of menus. */ + menuItemMove?: Maybe + /** Request an invoice for the order using plugin. */ + invoiceRequest?: Maybe + /** Requests deletion of an invoice. */ + invoiceRequestDelete?: Maybe + /** Creates a ready to send invoice. */ + invoiceCreate?: Maybe + /** Deletes an invoice. */ + invoiceDelete?: Maybe + /** Updates an invoice. */ + invoiceUpdate?: Maybe + /** Send an invoice notification to the customer. */ + invoiceSendNotification?: Maybe + /** Activate a gift card. */ + giftCardActivate?: Maybe + /** Creates a new gift card. */ + giftCardCreate?: Maybe + /** Deactivate a gift card. */ + giftCardDeactivate?: Maybe + /** Update a gift card. */ + giftCardUpdate?: Maybe + /** Update plugin configuration. */ + pluginUpdate?: Maybe + /** Creates a new sale. */ + saleCreate?: Maybe + /** Deletes a sale. */ + saleDelete?: Maybe + /** Deletes sales. */ + saleBulkDelete?: Maybe + /** Updates a sale. */ + saleUpdate?: Maybe + /** Adds products, categories, collections to a voucher. */ + saleCataloguesAdd?: Maybe + /** Removes products, categories, collections from a sale. */ + saleCataloguesRemove?: Maybe + /** Creates/updates translations for a sale. */ + saleTranslate?: Maybe + /** Manage sale's availability in channels. */ + saleChannelListingUpdate?: Maybe + /** Creates a new voucher. */ + voucherCreate?: Maybe + /** Deletes a voucher. */ + voucherDelete?: Maybe + /** Deletes vouchers. */ + voucherBulkDelete?: Maybe + /** Updates a voucher. */ + voucherUpdate?: Maybe + /** Adds products, categories, collections to a voucher. */ + voucherCataloguesAdd?: Maybe + /** Removes products, categories, collections from a voucher. */ + voucherCataloguesRemove?: Maybe + /** Creates/Updates translations for Voucher. */ + voucherTranslate?: Maybe + /** Manage voucher's availability in channels. */ + voucherChannelListingUpdate?: Maybe + /** Export products to csv file. */ + exportProducts?: Maybe + /** Upload a file. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec */ + fileUpload?: Maybe + /** Adds a gift card or a voucher to a checkout. */ + checkoutAddPromoCode?: Maybe + /** Update billing address in the existing checkout. */ + checkoutBillingAddressUpdate?: Maybe + /** Completes the checkout. As a result a new order is created and a payment charge is made. This action requires a successful payment before it can be performed. In case additional confirmation step as 3D secure is required confirmationNeeded flag will be set to True and no order created until payment is confirmed with second call of this mutation. */ + checkoutComplete?: Maybe + /** Create a new checkout. */ + checkoutCreate?: Maybe + /** Sets the customer as the owner of the checkout. */ + checkoutCustomerAttach?: Maybe + /** Removes the user assigned as the owner of the checkout. */ + checkoutCustomerDetach?: Maybe + /** Updates email address in the existing checkout object. */ + checkoutEmailUpdate?: Maybe + /** Deletes a CheckoutLine. */ + checkoutLineDelete?: Maybe + /** Adds a checkout line to the existing checkout. */ + checkoutLinesAdd?: Maybe + /** Updates checkout line in the existing checkout. */ + checkoutLinesUpdate?: Maybe + /** Remove a gift card or a voucher from a checkout. */ + checkoutRemovePromoCode?: Maybe + /** Create a new payment for given checkout. */ + checkoutPaymentCreate?: Maybe + /** Update shipping address in the existing checkout. */ + checkoutShippingAddressUpdate?: Maybe + /** Updates the shipping address of the checkout. */ + checkoutShippingMethodUpdate?: Maybe + /** Update language code in the existing checkout. */ + checkoutLanguageCodeUpdate?: Maybe + /** Creates new channel. */ + channelCreate?: Maybe + /** Update a channel. */ + channelUpdate?: Maybe + /** Delete a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. */ + channelDelete?: Maybe + /** Activate a channel. */ + channelActivate?: Maybe + /** Deactivate a channel. */ + channelDeactivate?: Maybe + /** Creates an attribute. */ + attributeCreate?: Maybe + /** Deletes an attribute. */ + attributeDelete?: Maybe + /** Updates attribute. */ + attributeUpdate?: Maybe + /** Creates/Updates translations for attribute. */ + attributeTranslate?: Maybe + /** Deletes attributes. */ + attributeBulkDelete?: Maybe + /** Deletes values of attributes. */ + attributeValueBulkDelete?: Maybe + /** Creates a value for an attribute. */ + attributeValueCreate?: Maybe + /** Deletes a value of an attribute. */ + attributeValueDelete?: Maybe + /** Updates value of an attribute. */ + attributeValueUpdate?: Maybe + /** Creates/Updates translations for attribute value. */ + attributeValueTranslate?: Maybe + /** Reorder the values of an attribute. */ + attributeReorderValues?: Maybe + /** Creates a new app. */ + appCreate?: Maybe + /** Updates an existing app. */ + appUpdate?: Maybe + /** Deletes an app. */ + appDelete?: Maybe + /** Creates a new token. */ + appTokenCreate?: Maybe + /** Deletes an authentication token assigned to app. */ + appTokenDelete?: Maybe + /** Verify provided app token. */ + appTokenVerify?: Maybe + /** Install new app by using app manifest. */ + appInstall?: Maybe + /** Retry failed installation of new app. */ + appRetryInstall?: Maybe + /** Delete failed installation. */ + appDeleteFailedInstallation?: Maybe + /** Fetch and validate manifest. */ + appFetchManifest?: Maybe + /** Activate the app. */ + appActivate?: Maybe + /** Deactivate the app. */ + appDeactivate?: Maybe + /** Create JWT token. */ + tokenCreate?: Maybe + /** Refresh JWT token. Mutation tries to take refreshToken from the input.If it fails it will try to take refreshToken from the http-only cookie -refreshToken. csrfToken is required when refreshToken is provided as a cookie. */ + tokenRefresh?: Maybe + /** Verify JWT token. */ + tokenVerify?: Maybe + /** Deactivate all JWT tokens of the currently authenticated user. */ + tokensDeactivateAll?: Maybe + /** Prepare external authentication url for user by custom plugin. */ + externalAuthenticationUrl?: Maybe + /** Obtain external access tokens for user by custom plugin. */ + externalObtainAccessTokens?: Maybe + /** Refresh user's access by custom plugin. */ + externalRefresh?: Maybe + /** Logout user by custom plugin. */ + externalLogout?: Maybe + /** Verify external authentication data by plugin. */ + externalVerify?: Maybe + /** Sends an email with the account password modification link. */ + requestPasswordReset?: Maybe + /** Confirm user account with token sent by email during registration. */ + confirmAccount?: Maybe + /** Sets the user's password from the token sent by email using the RequestPasswordReset mutation. */ + setPassword?: Maybe + /** Change the password of the logged in user. */ + passwordChange?: Maybe + /** Request email change of the logged in user. */ + requestEmailChange?: Maybe + /** Confirm the email change of the logged-in user. */ + confirmEmailChange?: Maybe + /** Create a new address for the customer. */ + accountAddressCreate?: Maybe + /** Updates an address of the logged-in user. */ + accountAddressUpdate?: Maybe + /** Delete an address of the logged-in user. */ + accountAddressDelete?: Maybe + /** Sets a default address for the authenticated user. */ + accountSetDefaultAddress?: Maybe + /** Register a new user. */ + accountRegister?: Maybe + /** Updates the account of the logged-in user. */ + accountUpdate?: Maybe + /** Sends an email with the account removal link for the logged-in user. */ + accountRequestDeletion?: Maybe + /** Remove user account. */ + accountDelete?: Maybe + /** Creates user address. */ + addressCreate?: Maybe + /** Updates an address. */ + addressUpdate?: Maybe + /** Deletes an address. */ + addressDelete?: Maybe + /** Sets a default address for the given user. */ + addressSetDefault?: Maybe /** Creates a new customer. */ - customerCreate?: Maybe - /** Updates the default address of an existing customer. */ - customerDefaultAddressUpdate?: Maybe - /** Sends a reset password email to the customer, as the first step in the reset password process. */ - customerRecover?: Maybe - /** Resets a customer’s password with a token received from `CustomerRecover`. */ - customerReset?: Maybe - /** Resets a customer’s password with the reset password url received from `CustomerRecover`. */ - customerResetByUrl?: Maybe + customerCreate?: Maybe /** Updates an existing customer. */ - customerUpdate?: Maybe + customerUpdate?: Maybe + /** Deletes a customer. */ + customerDelete?: Maybe + /** Deletes customers. */ + customerBulkDelete?: Maybe + /** Creates a new staff user. */ + staffCreate?: Maybe + /** Updates an existing staff user. */ + staffUpdate?: Maybe + /** Deletes a staff user. */ + staffDelete?: Maybe + /** Deletes staff users. */ + staffBulkDelete?: Maybe + /** Create a user avatar. Only for staff members. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec */ + userAvatarUpdate?: Maybe + /** Deletes a user avatar. Only for staff members. */ + userAvatarDelete?: Maybe + /** Activate or deactivate users. */ + userBulkSetActive?: Maybe + /** Create new permission group. */ + permissionGroupCreate?: Maybe + /** Update permission group. */ + permissionGroupUpdate?: Maybe + /** Delete permission group. */ + permissionGroupDelete?: Maybe } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutAttributesUpdateArgs = { +export type MutationWebhookCreateArgs = { + input: WebhookCreateInput +} + +export type MutationWebhookDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationWebhookUpdateArgs = { + id: Scalars['ID'] + input: WebhookUpdateInput +} + +export type MutationCreateWarehouseArgs = { + input: WarehouseCreateInput +} + +export type MutationUpdateWarehouseArgs = { + id: Scalars['ID'] + input: WarehouseUpdateInput +} + +export type MutationDeleteWarehouseArgs = { + id: Scalars['ID'] +} + +export type MutationAssignWarehouseShippingZoneArgs = { + id: Scalars['ID'] + shippingZoneIds: Array +} + +export type MutationUnassignWarehouseShippingZoneArgs = { + id: Scalars['ID'] + shippingZoneIds: Array +} + +export type MutationStaffNotificationRecipientCreateArgs = { + input: StaffNotificationRecipientInput +} + +export type MutationStaffNotificationRecipientUpdateArgs = { + id: Scalars['ID'] + input: StaffNotificationRecipientInput +} + +export type MutationStaffNotificationRecipientDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationShopDomainUpdateArgs = { + input?: Maybe +} + +export type MutationShopSettingsUpdateArgs = { + input: ShopSettingsInput +} + +export type MutationShopSettingsTranslateArgs = { + input: ShopSettingsTranslationInput + languageCode: LanguageCodeEnum +} + +export type MutationShopAddressUpdateArgs = { + input?: Maybe +} + +export type MutationOrderSettingsUpdateArgs = { + input: OrderSettingsUpdateInput +} + +export type MutationShippingMethodChannelListingUpdateArgs = { + id: Scalars['ID'] + input: ShippingMethodChannelListingInput +} + +export type MutationShippingPriceCreateArgs = { + input: ShippingPriceInput +} + +export type MutationShippingPriceDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationShippingPriceBulkDeleteArgs = { + ids: Array> +} + +export type MutationShippingPriceUpdateArgs = { + id: Scalars['ID'] + input: ShippingPriceInput +} + +export type MutationShippingPriceTranslateArgs = { + id: Scalars['ID'] + input: NameTranslationInput + languageCode: LanguageCodeEnum +} + +export type MutationShippingPriceExcludeProductsArgs = { + id: Scalars['ID'] + input: ShippingPriceExcludeProductsInput +} + +export type MutationShippingPriceRemoveProductFromExcludeArgs = { + id: Scalars['ID'] + products: Array> +} + +export type MutationShippingZoneCreateArgs = { + input: ShippingZoneCreateInput +} + +export type MutationShippingZoneDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationShippingZoneBulkDeleteArgs = { + ids: Array> +} + +export type MutationShippingZoneUpdateArgs = { + id: Scalars['ID'] + input: ShippingZoneUpdateInput +} + +export type MutationProductAttributeAssignArgs = { + operations: Array> + productTypeId: Scalars['ID'] +} + +export type MutationProductAttributeUnassignArgs = { + attributeIds: Array> + productTypeId: Scalars['ID'] +} + +export type MutationCategoryCreateArgs = { + input: CategoryInput + parent?: Maybe +} + +export type MutationCategoryDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationCategoryBulkDeleteArgs = { + ids: Array> +} + +export type MutationCategoryUpdateArgs = { + id: Scalars['ID'] + input: CategoryInput +} + +export type MutationCategoryTranslateArgs = { + id: Scalars['ID'] + input: TranslationInput + languageCode: LanguageCodeEnum +} + +export type MutationCollectionAddProductsArgs = { + collectionId: Scalars['ID'] + products: Array> +} + +export type MutationCollectionCreateArgs = { + input: CollectionCreateInput +} + +export type MutationCollectionDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationCollectionReorderProductsArgs = { + collectionId: Scalars['ID'] + moves: Array> +} + +export type MutationCollectionBulkDeleteArgs = { + ids: Array> +} + +export type MutationCollectionRemoveProductsArgs = { + collectionId: Scalars['ID'] + products: Array> +} + +export type MutationCollectionUpdateArgs = { + id: Scalars['ID'] + input: CollectionInput +} + +export type MutationCollectionTranslateArgs = { + id: Scalars['ID'] + input: TranslationInput + languageCode: LanguageCodeEnum +} + +export type MutationCollectionChannelListingUpdateArgs = { + id: Scalars['ID'] + input: CollectionChannelListingUpdateInput +} + +export type MutationProductCreateArgs = { + input: ProductCreateInput +} + +export type MutationProductDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationProductBulkDeleteArgs = { + ids: Array> +} + +export type MutationProductUpdateArgs = { + id: Scalars['ID'] + input: ProductInput +} + +export type MutationProductTranslateArgs = { + id: Scalars['ID'] + input: TranslationInput + languageCode: LanguageCodeEnum +} + +export type MutationProductChannelListingUpdateArgs = { + id: Scalars['ID'] + input: ProductChannelListingUpdateInput +} + +export type MutationProductMediaCreateArgs = { + input: ProductMediaCreateInput +} + +export type MutationProductVariantReorderArgs = { + moves: Array> + productId: Scalars['ID'] +} + +export type MutationProductMediaDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationProductMediaBulkDeleteArgs = { + ids: Array> +} + +export type MutationProductMediaReorderArgs = { + mediaIds: Array> + productId: Scalars['ID'] +} + +export type MutationProductMediaUpdateArgs = { + id: Scalars['ID'] + input: ProductMediaUpdateInput +} + +export type MutationProductTypeCreateArgs = { + input: ProductTypeInput +} + +export type MutationProductTypeDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationProductTypeBulkDeleteArgs = { + ids: Array> +} + +export type MutationProductTypeUpdateArgs = { + id: Scalars['ID'] + input: ProductTypeInput +} + +export type MutationProductTypeReorderAttributesArgs = { + moves: Array> + productTypeId: Scalars['ID'] + type: ProductAttributeType +} + +export type MutationProductReorderAttributeValuesArgs = { + attributeId: Scalars['ID'] + moves: Array> + productId: Scalars['ID'] +} + +export type MutationDigitalContentCreateArgs = { + input: DigitalContentUploadInput + variantId: Scalars['ID'] +} + +export type MutationDigitalContentDeleteArgs = { + variantId: Scalars['ID'] +} + +export type MutationDigitalContentUpdateArgs = { + input: DigitalContentInput + variantId: Scalars['ID'] +} + +export type MutationDigitalContentUrlCreateArgs = { + input: DigitalContentUrlCreateInput +} + +export type MutationProductVariantCreateArgs = { + input: ProductVariantCreateInput +} + +export type MutationProductVariantDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationProductVariantBulkCreateArgs = { + product: Scalars['ID'] + variants: Array> +} + +export type MutationProductVariantBulkDeleteArgs = { + ids: Array> +} + +export type MutationProductVariantStocksCreateArgs = { + stocks: Array + variantId: Scalars['ID'] +} + +export type MutationProductVariantStocksDeleteArgs = { + variantId: Scalars['ID'] + warehouseIds?: Maybe> +} + +export type MutationProductVariantStocksUpdateArgs = { + stocks: Array + variantId: Scalars['ID'] +} + +export type MutationProductVariantUpdateArgs = { + id: Scalars['ID'] + input: ProductVariantInput +} + +export type MutationProductVariantSetDefaultArgs = { + productId: Scalars['ID'] + variantId: Scalars['ID'] +} + +export type MutationProductVariantTranslateArgs = { + id: Scalars['ID'] + input: NameTranslationInput + languageCode: LanguageCodeEnum +} + +export type MutationProductVariantChannelListingUpdateArgs = { + id: Scalars['ID'] + input: Array +} + +export type MutationProductVariantReorderAttributeValuesArgs = { + attributeId: Scalars['ID'] + moves: Array> + variantId: Scalars['ID'] +} + +export type MutationVariantMediaAssignArgs = { + mediaId: Scalars['ID'] + variantId: Scalars['ID'] +} + +export type MutationVariantMediaUnassignArgs = { + mediaId: Scalars['ID'] + variantId: Scalars['ID'] +} + +export type MutationPaymentCaptureArgs = { + amount?: Maybe + paymentId: Scalars['ID'] +} + +export type MutationPaymentRefundArgs = { + amount?: Maybe + paymentId: Scalars['ID'] +} + +export type MutationPaymentVoidArgs = { + paymentId: Scalars['ID'] +} + +export type MutationPaymentInitializeArgs = { + gateway: Scalars['String'] + paymentData?: Maybe +} + +export type MutationPageCreateArgs = { + input: PageCreateInput +} + +export type MutationPageDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationPageBulkDeleteArgs = { + ids: Array> +} + +export type MutationPageBulkPublishArgs = { + ids: Array> + isPublished: Scalars['Boolean'] +} + +export type MutationPageUpdateArgs = { + id: Scalars['ID'] + input: PageInput +} + +export type MutationPageTranslateArgs = { + id: Scalars['ID'] + input: PageTranslationInput + languageCode: LanguageCodeEnum +} + +export type MutationPageTypeCreateArgs = { + input: PageTypeCreateInput +} + +export type MutationPageTypeUpdateArgs = { + id?: Maybe + input: PageTypeUpdateInput +} + +export type MutationPageTypeDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationPageTypeBulkDeleteArgs = { + ids: Array +} + +export type MutationPageAttributeAssignArgs = { + attributeIds: Array + pageTypeId: Scalars['ID'] +} + +export type MutationPageAttributeUnassignArgs = { + attributeIds: Array + pageTypeId: Scalars['ID'] +} + +export type MutationPageTypeReorderAttributesArgs = { + moves: Array + pageTypeId: Scalars['ID'] +} + +export type MutationPageReorderAttributeValuesArgs = { + attributeId: Scalars['ID'] + moves: Array> + pageId: Scalars['ID'] +} + +export type MutationDraftOrderCompleteArgs = { + id: Scalars['ID'] +} + +export type MutationDraftOrderCreateArgs = { + input: DraftOrderCreateInput +} + +export type MutationDraftOrderDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationDraftOrderBulkDeleteArgs = { + ids: Array> +} + +export type MutationDraftOrderLinesBulkDeleteArgs = { + ids: Array> +} + +export type MutationDraftOrderUpdateArgs = { + id: Scalars['ID'] + input: DraftOrderInput +} + +export type MutationOrderAddNoteArgs = { + order: Scalars['ID'] + input: OrderAddNoteInput +} + +export type MutationOrderCancelArgs = { + id: Scalars['ID'] +} + +export type MutationOrderCaptureArgs = { + amount: Scalars['PositiveDecimal'] + id: Scalars['ID'] +} + +export type MutationOrderConfirmArgs = { + id: Scalars['ID'] +} + +export type MutationOrderFulfillArgs = { + input: OrderFulfillInput + order?: Maybe +} + +export type MutationOrderFulfillmentCancelArgs = { + id: Scalars['ID'] + input: FulfillmentCancelInput +} + +export type MutationOrderFulfillmentUpdateTrackingArgs = { + id: Scalars['ID'] + input: FulfillmentUpdateTrackingInput +} + +export type MutationOrderFulfillmentRefundProductsArgs = { + input: OrderRefundProductsInput + order: Scalars['ID'] +} + +export type MutationOrderFulfillmentReturnProductsArgs = { + input: OrderReturnProductsInput + order: Scalars['ID'] +} + +export type MutationOrderLinesCreateArgs = { + id: Scalars['ID'] + input: Array> +} + +export type MutationOrderLineDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationOrderLineUpdateArgs = { + id: Scalars['ID'] + input: OrderLineInput +} + +export type MutationOrderDiscountAddArgs = { + input: OrderDiscountCommonInput + orderId: Scalars['ID'] +} + +export type MutationOrderDiscountUpdateArgs = { + discountId: Scalars['ID'] + input: OrderDiscountCommonInput +} + +export type MutationOrderDiscountDeleteArgs = { + discountId: Scalars['ID'] +} + +export type MutationOrderLineDiscountUpdateArgs = { + input: OrderDiscountCommonInput + orderLineId: Scalars['ID'] +} + +export type MutationOrderLineDiscountRemoveArgs = { + orderLineId: Scalars['ID'] +} + +export type MutationOrderMarkAsPaidArgs = { + id: Scalars['ID'] + transactionReference?: Maybe +} + +export type MutationOrderRefundArgs = { + amount: Scalars['PositiveDecimal'] + id: Scalars['ID'] +} + +export type MutationOrderUpdateArgs = { + id: Scalars['ID'] + input: OrderUpdateInput +} + +export type MutationOrderUpdateShippingArgs = { + order: Scalars['ID'] + input?: Maybe +} + +export type MutationOrderVoidArgs = { + id: Scalars['ID'] +} + +export type MutationOrderBulkCancelArgs = { + ids: Array> +} + +export type MutationDeleteMetadataArgs = { + id: Scalars['ID'] + keys: Array +} + +export type MutationDeletePrivateMetadataArgs = { + id: Scalars['ID'] + keys: Array +} + +export type MutationUpdateMetadataArgs = { + id: Scalars['ID'] + input: Array +} + +export type MutationUpdatePrivateMetadataArgs = { + id: Scalars['ID'] + input: Array +} + +export type MutationAssignNavigationArgs = { + menu?: Maybe + navigationType: NavigationType +} + +export type MutationMenuCreateArgs = { + input: MenuCreateInput +} + +export type MutationMenuDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationMenuBulkDeleteArgs = { + ids: Array> +} + +export type MutationMenuUpdateArgs = { + id: Scalars['ID'] + input: MenuInput +} + +export type MutationMenuItemCreateArgs = { + input: MenuItemCreateInput +} + +export type MutationMenuItemDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationMenuItemBulkDeleteArgs = { + ids: Array> +} + +export type MutationMenuItemUpdateArgs = { + id: Scalars['ID'] + input: MenuItemInput +} + +export type MutationMenuItemTranslateArgs = { + id: Scalars['ID'] + input: NameTranslationInput + languageCode: LanguageCodeEnum +} + +export type MutationMenuItemMoveArgs = { + menu: Scalars['ID'] + moves: Array> +} + +export type MutationInvoiceRequestArgs = { + number?: Maybe + orderId: Scalars['ID'] +} + +export type MutationInvoiceRequestDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationInvoiceCreateArgs = { + input: InvoiceCreateInput + orderId: Scalars['ID'] +} + +export type MutationInvoiceDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationInvoiceUpdateArgs = { + id: Scalars['ID'] + input: UpdateInvoiceInput +} + +export type MutationInvoiceSendNotificationArgs = { + id: Scalars['ID'] +} + +export type MutationGiftCardActivateArgs = { + id: Scalars['ID'] +} + +export type MutationGiftCardCreateArgs = { + input: GiftCardCreateInput +} + +export type MutationGiftCardDeactivateArgs = { + id: Scalars['ID'] +} + +export type MutationGiftCardUpdateArgs = { + id: Scalars['ID'] + input: GiftCardUpdateInput +} + +export type MutationPluginUpdateArgs = { + id: Scalars['ID'] + input: PluginUpdateInput +} + +export type MutationSaleCreateArgs = { + input: SaleInput +} + +export type MutationSaleDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationSaleBulkDeleteArgs = { + ids: Array> +} + +export type MutationSaleUpdateArgs = { + id: Scalars['ID'] + input: SaleInput +} + +export type MutationSaleCataloguesAddArgs = { + id: Scalars['ID'] + input: CatalogueInput +} + +export type MutationSaleCataloguesRemoveArgs = { + id: Scalars['ID'] + input: CatalogueInput +} + +export type MutationSaleTranslateArgs = { + id: Scalars['ID'] + input: NameTranslationInput + languageCode: LanguageCodeEnum +} + +export type MutationSaleChannelListingUpdateArgs = { + id: Scalars['ID'] + input: SaleChannelListingInput +} + +export type MutationVoucherCreateArgs = { + input: VoucherInput +} + +export type MutationVoucherDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationVoucherBulkDeleteArgs = { + ids: Array> +} + +export type MutationVoucherUpdateArgs = { + id: Scalars['ID'] + input: VoucherInput +} + +export type MutationVoucherCataloguesAddArgs = { + id: Scalars['ID'] + input: CatalogueInput +} + +export type MutationVoucherCataloguesRemoveArgs = { + id: Scalars['ID'] + input: CatalogueInput +} + +export type MutationVoucherTranslateArgs = { + id: Scalars['ID'] + input: NameTranslationInput + languageCode: LanguageCodeEnum +} + +export type MutationVoucherChannelListingUpdateArgs = { + id: Scalars['ID'] + input: VoucherChannelListingInput +} + +export type MutationExportProductsArgs = { + input: ExportProductsInput +} + +export type MutationFileUploadArgs = { + file: Scalars['Upload'] +} + +export type MutationCheckoutAddPromoCodeArgs = { checkoutId: Scalars['ID'] - input: CheckoutAttributesUpdateInput + promoCode: Scalars['String'] } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutAttributesUpdateV2Args = { - checkoutId: Scalars['ID'] - input: CheckoutAttributesUpdateV2Input -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutCompleteFreeArgs = { +export type MutationCheckoutBillingAddressUpdateArgs = { + billingAddress: AddressInput checkoutId: Scalars['ID'] } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutCompleteWithCreditCardArgs = { +export type MutationCheckoutCompleteArgs = { checkoutId: Scalars['ID'] - payment: CreditCardPaymentInput + paymentData?: Maybe + redirectUrl?: Maybe + storeSource?: Maybe } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutCompleteWithCreditCardV2Args = { - checkoutId: Scalars['ID'] - payment: CreditCardPaymentInputV2 -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutCompleteWithTokenizedPaymentArgs = { - checkoutId: Scalars['ID'] - payment: TokenizedPaymentInput -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutCompleteWithTokenizedPaymentV2Args = { - checkoutId: Scalars['ID'] - payment: TokenizedPaymentInputV2 -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutCompleteWithTokenizedPaymentV3Args = { - checkoutId: Scalars['ID'] - payment: TokenizedPaymentInputV3 -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutCreateArgs = { input: CheckoutCreateInput } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutCustomerAssociateArgs = { +export type MutationCheckoutCustomerAttachArgs = { checkoutId: Scalars['ID'] - customerAccessToken: Scalars['String'] + customerId?: Maybe } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutCustomerAssociateV2Args = { - checkoutId: Scalars['ID'] - customerAccessToken: Scalars['String'] -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutCustomerDisassociateArgs = { +export type MutationCheckoutCustomerDetachArgs = { checkoutId: Scalars['ID'] } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutCustomerDisassociateV2Args = { - checkoutId: Scalars['ID'] -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutDiscountCodeApplyArgs = { - discountCode: Scalars['String'] - checkoutId: Scalars['ID'] -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutDiscountCodeApplyV2Args = { - discountCode: Scalars['String'] - checkoutId: Scalars['ID'] -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutDiscountCodeRemoveArgs = { - checkoutId: Scalars['ID'] -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutEmailUpdateArgs = { - checkoutId: Scalars['ID'] + checkoutId?: Maybe email: Scalars['String'] } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutEmailUpdateV2Args = { +export type MutationCheckoutLineDeleteArgs = { checkoutId: Scalars['ID'] - email: Scalars['String'] + lineId?: Maybe } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutGiftCardApplyArgs = { - giftCardCode: Scalars['String'] +export type MutationCheckoutLinesAddArgs = { checkoutId: Scalars['ID'] + lines: Array> } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutGiftCardRemoveArgs = { - appliedGiftCardId: Scalars['ID'] +export type MutationCheckoutLinesUpdateArgs = { checkoutId: Scalars['ID'] + lines: Array> } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutGiftCardRemoveV2Args = { - appliedGiftCardId: Scalars['ID'] +export type MutationCheckoutRemovePromoCodeArgs = { checkoutId: Scalars['ID'] + promoCode: Scalars['String'] } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutGiftCardsAppendArgs = { - giftCardCodes: Array +export type MutationCheckoutPaymentCreateArgs = { checkoutId: Scalars['ID'] + input: PaymentInput } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutLineItemsAddArgs = { - lineItems: Array - checkoutId: Scalars['ID'] -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutLineItemsRemoveArgs = { - checkoutId: Scalars['ID'] - lineItemIds: Array -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutLineItemsReplaceArgs = { - lineItems: Array - checkoutId: Scalars['ID'] -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutLineItemsUpdateArgs = { - checkoutId: Scalars['ID'] - lineItems: Array -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ export type MutationCheckoutShippingAddressUpdateArgs = { - shippingAddress: MailingAddressInput checkoutId: Scalars['ID'] + shippingAddress: AddressInput } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutShippingAddressUpdateV2Args = { - shippingAddress: MailingAddressInput +export type MutationCheckoutShippingMethodUpdateArgs = { + checkoutId?: Maybe + shippingMethodId: Scalars['ID'] +} + +export type MutationCheckoutLanguageCodeUpdateArgs = { checkoutId: Scalars['ID'] + languageCode: LanguageCodeEnum } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCheckoutShippingLineUpdateArgs = { - checkoutId: Scalars['ID'] - shippingRateHandle: Scalars['String'] +export type MutationChannelCreateArgs = { + input: ChannelCreateInput } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCustomerAccessTokenCreateArgs = { - input: CustomerAccessTokenCreateInput -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCustomerAccessTokenCreateWithMultipassArgs = { - multipassToken: Scalars['String'] -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCustomerAccessTokenDeleteArgs = { - customerAccessToken: Scalars['String'] -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCustomerAccessTokenRenewArgs = { - customerAccessToken: Scalars['String'] -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCustomerActivateArgs = { +export type MutationChannelUpdateArgs = { id: Scalars['ID'] - input: CustomerActivateInput + input: ChannelUpdateInput } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCustomerActivateByUrlArgs = { - activationUrl: Scalars['URL'] - password: Scalars['String'] -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCustomerAddressCreateArgs = { - customerAccessToken: Scalars['String'] - address: MailingAddressInput -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCustomerAddressDeleteArgs = { +export type MutationChannelDeleteArgs = { id: Scalars['ID'] - customerAccessToken: Scalars['String'] + input?: Maybe } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCustomerAddressUpdateArgs = { - customerAccessToken: Scalars['String'] +export type MutationChannelActivateArgs = { id: Scalars['ID'] - address: MailingAddressInput } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCustomerCreateArgs = { - input: CustomerCreateInput +export type MutationChannelDeactivateArgs = { + id: Scalars['ID'] } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCustomerDefaultAddressUpdateArgs = { - customerAccessToken: Scalars['String'] - addressId: Scalars['ID'] +export type MutationAttributeCreateArgs = { + input: AttributeCreateInput } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCustomerRecoverArgs = { +export type MutationAttributeDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationAttributeUpdateArgs = { + id: Scalars['ID'] + input: AttributeUpdateInput +} + +export type MutationAttributeTranslateArgs = { + id: Scalars['ID'] + input: NameTranslationInput + languageCode: LanguageCodeEnum +} + +export type MutationAttributeBulkDeleteArgs = { + ids: Array> +} + +export type MutationAttributeValueBulkDeleteArgs = { + ids: Array> +} + +export type MutationAttributeValueCreateArgs = { + attribute: Scalars['ID'] + input: AttributeValueCreateInput +} + +export type MutationAttributeValueDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationAttributeValueUpdateArgs = { + id: Scalars['ID'] + input: AttributeValueCreateInput +} + +export type MutationAttributeValueTranslateArgs = { + id: Scalars['ID'] + input: AttributeValueTranslationInput + languageCode: LanguageCodeEnum +} + +export type MutationAttributeReorderValuesArgs = { + attributeId: Scalars['ID'] + moves: Array> +} + +export type MutationAppCreateArgs = { + input: AppInput +} + +export type MutationAppUpdateArgs = { + id: Scalars['ID'] + input: AppInput +} + +export type MutationAppDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationAppTokenCreateArgs = { + input: AppTokenInput +} + +export type MutationAppTokenDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationAppTokenVerifyArgs = { + token: Scalars['String'] +} + +export type MutationAppInstallArgs = { + input: AppInstallInput +} + +export type MutationAppRetryInstallArgs = { + activateAfterInstallation?: Maybe + id: Scalars['ID'] +} + +export type MutationAppDeleteFailedInstallationArgs = { + id: Scalars['ID'] +} + +export type MutationAppFetchManifestArgs = { + manifestUrl: Scalars['String'] +} + +export type MutationAppActivateArgs = { + id: Scalars['ID'] +} + +export type MutationAppDeactivateArgs = { + id: Scalars['ID'] +} + +export type MutationTokenCreateArgs = { email: Scalars['String'] -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCustomerResetArgs = { - id: Scalars['ID'] - input: CustomerResetInput -} - -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ -export type MutationCustomerResetByUrlArgs = { - resetUrl: Scalars['URL'] password: Scalars['String'] } -/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationTokenRefreshArgs = { + csrfToken?: Maybe + refreshToken?: Maybe +} + +export type MutationTokenVerifyArgs = { + token: Scalars['String'] +} + +export type MutationExternalAuthenticationUrlArgs = { + input: Scalars['JSONString'] + pluginId: Scalars['String'] +} + +export type MutationExternalObtainAccessTokensArgs = { + input: Scalars['JSONString'] + pluginId: Scalars['String'] +} + +export type MutationExternalRefreshArgs = { + input: Scalars['JSONString'] + pluginId: Scalars['String'] +} + +export type MutationExternalLogoutArgs = { + input: Scalars['JSONString'] + pluginId: Scalars['String'] +} + +export type MutationExternalVerifyArgs = { + input: Scalars['JSONString'] + pluginId: Scalars['String'] +} + +export type MutationRequestPasswordResetArgs = { + email: Scalars['String'] + redirectUrl: Scalars['String'] +} + +export type MutationConfirmAccountArgs = { + email: Scalars['String'] + token: Scalars['String'] +} + +export type MutationSetPasswordArgs = { + email: Scalars['String'] + password: Scalars['String'] + token: Scalars['String'] +} + +export type MutationPasswordChangeArgs = { + newPassword: Scalars['String'] + oldPassword: Scalars['String'] +} + +export type MutationRequestEmailChangeArgs = { + newEmail: Scalars['String'] + password: Scalars['String'] + redirectUrl: Scalars['String'] +} + +export type MutationConfirmEmailChangeArgs = { + token: Scalars['String'] +} + +export type MutationAccountAddressCreateArgs = { + input: AddressInput + type?: Maybe +} + +export type MutationAccountAddressUpdateArgs = { + id: Scalars['ID'] + input: AddressInput +} + +export type MutationAccountAddressDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationAccountSetDefaultAddressArgs = { + id: Scalars['ID'] + type: AddressTypeEnum +} + +export type MutationAccountRegisterArgs = { + input: AccountRegisterInput +} + +export type MutationAccountUpdateArgs = { + input: AccountInput +} + +export type MutationAccountRequestDeletionArgs = { + redirectUrl: Scalars['String'] +} + +export type MutationAccountDeleteArgs = { + token: Scalars['String'] +} + +export type MutationAddressCreateArgs = { + input: AddressInput + userId: Scalars['ID'] +} + +export type MutationAddressUpdateArgs = { + id: Scalars['ID'] + input: AddressInput +} + +export type MutationAddressDeleteArgs = { + id: Scalars['ID'] +} + +export type MutationAddressSetDefaultArgs = { + addressId: Scalars['ID'] + type: AddressTypeEnum + userId: Scalars['ID'] +} + +export type MutationCustomerCreateArgs = { + input: UserCreateInput +} + export type MutationCustomerUpdateArgs = { - customerAccessToken: Scalars['String'] - customer: CustomerUpdateInput + id: Scalars['ID'] + input: CustomerInput } -/** An object with an ID to support global identification. */ -export type Node = { - /** Globally unique identifier. */ +export type MutationCustomerDeleteArgs = { id: Scalars['ID'] } -/** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ -export type Order = Node & { - __typename?: 'Order' - /** The reason for the order's cancellation. Returns `null` if the order wasn't canceled. */ - cancelReason?: Maybe - /** The date and time when the order was canceled. Returns null if the order wasn't canceled. */ - canceledAt?: Maybe - /** The code of the currency used for the payment. */ - currencyCode: CurrencyCode - /** The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes are not included unless the order is a taxes-included order. */ - currentSubtotalPrice: MoneyV2 - /** The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed. */ - currentTotalPrice: MoneyV2 - /** The total of all taxes applied to the order, excluding taxes for returned line items. */ - currentTotalTax: MoneyV2 - /** The locale code in which this specific order happened. */ - customerLocale?: Maybe - /** The unique URL that the customer can use to access the order. */ - customerUrl?: Maybe - /** Discounts that have been applied on the order. */ - discountApplications: DiscountApplicationConnection - /** Whether the order has had any edits applied or not. */ - edited: Scalars['Boolean'] - /** The customer's email address. */ - email?: Maybe - /** The financial status of the order. */ - financialStatus?: Maybe - /** The fulfillment status for the order. */ - fulfillmentStatus: OrderFulfillmentStatus - /** Globally unique identifier. */ +export type MutationCustomerBulkDeleteArgs = { + ids: Array> +} + +export type MutationStaffCreateArgs = { + input: StaffCreateInput +} + +export type MutationStaffUpdateArgs = { id: Scalars['ID'] - /** List of the order’s line items. */ - lineItems: OrderLineItemConnection - /** - * Unique identifier for the order that appears on the order. - * For example, _#1000_ or _Store1001. - */ - name: Scalars['String'] - /** A unique numeric identifier for the order for use by shop owner and customer. */ - orderNumber: Scalars['Int'] - /** The total price of the order before any applied edits. */ - originalTotalPrice: MoneyV2 - /** The customer's phone number for receiving SMS notifications. */ - phone?: Maybe - /** - * The date and time when the order was imported. - * This value can be set to dates in the past when importing from other systems. - * If no value is provided, it will be auto-generated based on current date and time. - */ - processedAt: Scalars['DateTime'] - /** The address to where the order will be shipped. */ - shippingAddress?: Maybe - /** The discounts that have been allocated onto the shipping line by discount applications. */ - shippingDiscountAllocations: Array - /** The unique URL for the order's status page. */ - statusUrl: Scalars['URL'] - /** - * Price of the order before shipping and taxes. - * @deprecated Use `subtotalPriceV2` instead - */ - subtotalPrice?: Maybe - /** Price of the order before duties, shipping and taxes. */ - subtotalPriceV2?: Maybe - /** List of the order’s successful fulfillments. */ - successfulFulfillments?: Maybe> - /** - * The sum of all the prices of all the items in the order, taxes and discounts included (must be positive). - * @deprecated Use `totalPriceV2` instead - */ - totalPrice: Scalars['Money'] - /** The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). */ - totalPriceV2: MoneyV2 - /** - * The total amount that has been refunded. - * @deprecated Use `totalRefundedV2` instead - */ - totalRefunded: Scalars['Money'] - /** The total amount that has been refunded. */ - totalRefundedV2: MoneyV2 - /** - * The total cost of shipping. - * @deprecated Use `totalShippingPriceV2` instead - */ - totalShippingPrice: Scalars['Money'] - /** The total cost of shipping. */ - totalShippingPriceV2: MoneyV2 - /** - * The total cost of taxes. - * @deprecated Use `totalTaxV2` instead - */ - totalTax?: Maybe - /** The total cost of taxes. */ - totalTaxV2?: Maybe + input: StaffUpdateInput } -/** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ -export type OrderDiscountApplicationsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe -} - -/** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ -export type OrderLineItemsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe -} - -/** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ -export type OrderSuccessfulFulfillmentsArgs = { - first?: Maybe -} - -/** Represents the reason for the order's cancellation. */ -export enum OrderCancelReason { - /** The customer wanted to cancel the order. */ - Customer = 'CUSTOMER', - /** The order was fraudulent. */ - Fraud = 'FRAUD', - /** There was insufficient inventory. */ - Inventory = 'INVENTORY', - /** Payment was declined. */ - Declined = 'DECLINED', - /** The order was canceled for an unlisted reason. */ - Other = 'OTHER', -} - -/** An auto-generated type for paginating through multiple Orders. */ -export type OrderConnection = { - __typename?: 'OrderConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** An auto-generated type which holds one Order and a cursor during pagination. */ -export type OrderEdge = { - __typename?: 'OrderEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of OrderEdge. */ - node: Order -} - -/** Represents the order's current financial status. */ -export enum OrderFinancialStatus { - /** Displayed as **Pending**. */ - Pending = 'PENDING', - /** Displayed as **Authorized**. */ - Authorized = 'AUTHORIZED', - /** Displayed as **Partially paid**. */ - PartiallyPaid = 'PARTIALLY_PAID', - /** Displayed as **Partially refunded**. */ - PartiallyRefunded = 'PARTIALLY_REFUNDED', - /** Displayed as **Voided**. */ - Voided = 'VOIDED', - /** Displayed as **Paid**. */ - Paid = 'PAID', - /** Displayed as **Refunded**. */ - Refunded = 'REFUNDED', -} - -/** Represents the order's current fulfillment status. */ -export enum OrderFulfillmentStatus { - /** Displayed as **Unfulfilled**. */ - Unfulfilled = 'UNFULFILLED', - /** Displayed as **Partially fulfilled**. */ - PartiallyFulfilled = 'PARTIALLY_FULFILLED', - /** Displayed as **Fulfilled**. */ - Fulfilled = 'FULFILLED', - /** Displayed as **Restocked**. */ - Restocked = 'RESTOCKED', - /** Displayed as **Pending fulfillment**. */ - PendingFulfillment = 'PENDING_FULFILLMENT', - /** Displayed as **Open**. */ - Open = 'OPEN', - /** Displayed as **In progress**. */ - InProgress = 'IN_PROGRESS', - /** Displayed as **Scheduled**. */ - Scheduled = 'SCHEDULED', -} - -/** Represents a single line in an order. There is one line item for each distinct product variant. */ -export type OrderLineItem = { - __typename?: 'OrderLineItem' - /** The number of entries associated to the line item minus the items that have been removed. */ - currentQuantity: Scalars['Int'] - /** List of custom attributes associated to the line item. */ - customAttributes: Array - /** The discounts that have been allocated onto the order line item by discount applications. */ - discountAllocations: Array - /** The total price of the line item, including discounts, and displayed in the presentment currency. */ - discountedTotalPrice: MoneyV2 - /** The total price of the line item, not including any discounts. The total price is calculated using the original unit price multiplied by the quantity, and it is displayed in the presentment currency. */ - originalTotalPrice: MoneyV2 - /** The number of products variants associated to the line item. */ - quantity: Scalars['Int'] - /** The title of the product combined with title of the variant. */ - title: Scalars['String'] - /** The product variant object associated to the line item. */ - variant?: Maybe -} - -/** An auto-generated type for paginating through multiple OrderLineItems. */ -export type OrderLineItemConnection = { - __typename?: 'OrderLineItemConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** An auto-generated type which holds one OrderLineItem and a cursor during pagination. */ -export type OrderLineItemEdge = { - __typename?: 'OrderLineItemEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of OrderLineItemEdge. */ - node: OrderLineItem -} - -/** The set of valid sort keys for the Order query. */ -export enum OrderSortKeys { - /** Sort by the `processed_at` value. */ - ProcessedAt = 'PROCESSED_AT', - /** Sort by the `total_price` value. */ - TotalPrice = 'TOTAL_PRICE', - /** Sort by the `id` value. */ - Id = 'ID', - /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. - */ - Relevance = 'RELEVANCE', -} - -/** Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. */ -export type Page = Node & { - __typename?: 'Page' - /** The description of the page, complete with HTML formatting. */ - body: Scalars['HTML'] - /** Summary of the page body. */ - bodySummary: Scalars['String'] - /** The timestamp of the page creation. */ - createdAt: Scalars['DateTime'] - /** A human-friendly unique string for the page automatically generated from its title. */ - handle: Scalars['String'] - /** Globally unique identifier. */ - id: Scalars['ID'] - /** The page's SEO information. */ - seo?: Maybe - /** The title of the page. */ - title: Scalars['String'] - /** The timestamp of the latest page update. */ - updatedAt: Scalars['DateTime'] - /** The url pointing to the page accessible from the web. */ - url: Scalars['URL'] -} - -/** An auto-generated type for paginating through multiple Pages. */ -export type PageConnection = { - __typename?: 'PageConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** An auto-generated type which holds one Page and a cursor during pagination. */ -export type PageEdge = { - __typename?: 'PageEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of PageEdge. */ - node: Page -} - -/** Information about pagination in a connection. */ -export type PageInfo = { - __typename?: 'PageInfo' - /** Indicates if there are more pages to fetch. */ - hasNextPage: Scalars['Boolean'] - /** Indicates if there are any pages prior to the current page. */ - hasPreviousPage: Scalars['Boolean'] -} - -/** The set of valid sort keys for the Page query. */ -export enum PageSortKeys { - /** Sort by the `title` value. */ - Title = 'TITLE', - /** Sort by the `updated_at` value. */ - UpdatedAt = 'UPDATED_AT', - /** Sort by the `id` value. */ - Id = 'ID', - /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. - */ - Relevance = 'RELEVANCE', -} - -/** A payment applied to a checkout. */ -export type Payment = Node & { - __typename?: 'Payment' - /** - * The amount of the payment. - * @deprecated Use `amountV2` instead - */ - amount: Scalars['Money'] - /** The amount of the payment. */ - amountV2: MoneyV2 - /** The billing address for the payment. */ - billingAddress?: Maybe - /** The checkout to which the payment belongs. */ - checkout: Checkout - /** The credit card used for the payment in the case of direct payments. */ - creditCard?: Maybe - /** A message describing a processing error during asynchronous processing. */ - errorMessage?: Maybe - /** Globally unique identifier. */ - id: Scalars['ID'] - /** A client-side generated token to identify a payment and perform idempotent operations. */ - idempotencyKey?: Maybe - /** The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow. */ - nextActionUrl?: Maybe - /** Whether or not the payment is still processing asynchronously. */ - ready: Scalars['Boolean'] - /** A flag to indicate if the payment is to be done in test mode for gateways that support it. */ - test: Scalars['Boolean'] - /** The actual transaction recorded by Shopify after having processed the payment with the gateway. */ - transaction?: Maybe -} - -/** Settings related to payments. */ -export type PaymentSettings = { - __typename?: 'PaymentSettings' - /** List of the card brands which the shop accepts. */ - acceptedCardBrands: Array - /** The url pointing to the endpoint to vault credit cards. */ - cardVaultUrl: Scalars['URL'] - /** The country where the shop is located. */ - countryCode: CountryCode - /** The three-letter code for the shop's primary currency. */ - currencyCode: CurrencyCode - /** A list of enabled currencies (ISO 4217 format) that the shop accepts. Merchants can enable currencies from their Shopify Payments settings in the Shopify admin. */ - enabledPresentmentCurrencies: Array - /** The shop’s Shopify Payments account id. */ - shopifyPaymentsAccountId?: Maybe - /** List of the digital wallets which the shop supports. */ - supportedDigitalWallets: Array -} - -/** The valid values for the types of payment token. */ -export enum PaymentTokenType { - /** Apple Pay token type. */ - ApplePay = 'APPLE_PAY', - /** Vault payment token type. */ - Vault = 'VAULT', - /** Shopify Pay token type. */ - ShopifyPay = 'SHOPIFY_PAY', - /** Google Pay token type. */ - GooglePay = 'GOOGLE_PAY', -} - -/** The value of the percentage pricing object. */ -export type PricingPercentageValue = { - __typename?: 'PricingPercentageValue' - /** The percentage value of the object. */ - percentage: Scalars['Float'] -} - -/** The price value (fixed or percentage) for a discount application. */ -export type PricingValue = MoneyV2 | PricingPercentageValue - -/** - * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. - * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). - */ -export type Product = Node & - HasMetafields & { - __typename?: 'Product' - /** Indicates if at least one product variant is available for sale. */ - availableForSale: Scalars['Boolean'] - /** List of collections a product belongs to. */ - collections: CollectionConnection - /** The compare at price of the product across all variants. */ - compareAtPriceRange: ProductPriceRange - /** The date and time when the product was created. */ - createdAt: Scalars['DateTime'] - /** Stripped description of the product, single line with HTML tags removed. */ - description: Scalars['String'] - /** The description of the product, complete with HTML formatting. */ - descriptionHtml: Scalars['HTML'] - /** - * A human-friendly unique string for the Product automatically generated from its title. - * They are used by the Liquid templating language to refer to objects. - */ - handle: Scalars['String'] - /** Globally unique identifier. */ - id: Scalars['ID'] - /** List of images associated with the product. */ - images: ImageConnection - /** The media associated with the product. */ - media: MediaConnection - /** The metafield associated with the resource. */ - metafield?: Maybe - /** A paginated list of metafields associated with the resource. */ - metafields: MetafieldConnection - /** - * The online store URL for the product. - * A value of `null` indicates that the product is not published to the Online Store sales channel. - */ - onlineStoreUrl?: Maybe - /** List of product options. */ - options: Array - /** List of price ranges in the presentment currencies for this shop. */ - presentmentPriceRanges: ProductPriceRangeConnection - /** The price range. */ - priceRange: ProductPriceRange - /** A categorization that a product can be tagged with, commonly used for filtering and searching. */ - productType: Scalars['String'] - /** The date and time when the product was published to the channel. */ - publishedAt: Scalars['DateTime'] - /** The product's SEO information. */ - seo: Seo - /** - * A comma separated list of tags that have been added to the product. - * Additional access scope required for private apps: unauthenticated_read_product_tags. - */ - tags: Array - /** The product’s title. */ - title: Scalars['String'] - /** The total quantity of inventory in stock for this Product. */ - totalInventory?: Maybe - /** - * The date and time when the product was last modified. - * A product's `updatedAt` value can change for different reasons. For example, if an order - * is placed for a product that has inventory tracking set up, then the inventory adjustment - * is counted as an update. - */ - updatedAt: Scalars['DateTime'] - /** - * Find a product’s variant based on its selected options. - * This is useful for converting a user’s selection of product options into a single matching variant. - * If there is not a variant for the selected options, `null` will be returned. - */ - variantBySelectedOptions?: Maybe - /** List of the product’s variants. */ - variants: ProductVariantConnection - /** The product’s vendor name. */ - vendor: Scalars['String'] - } - -/** - * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. - * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). - */ -export type ProductCollectionsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe -} - -/** - * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. - * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). - */ -export type ProductDescriptionArgs = { - truncateAt?: Maybe -} - -/** - * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. - * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). - */ -export type ProductImagesArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - maxWidth?: Maybe - maxHeight?: Maybe - crop?: Maybe - scale?: Maybe -} - -/** - * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. - * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). - */ -export type ProductMediaArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe -} - -/** - * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. - * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). - */ -export type ProductMetafieldArgs = { - namespace: Scalars['String'] - key: Scalars['String'] -} - -/** - * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. - * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). - */ -export type ProductMetafieldsArgs = { - namespace?: Maybe - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe -} - -/** - * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. - * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). - */ -export type ProductOptionsArgs = { - first?: Maybe -} - -/** - * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. - * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). - */ -export type ProductPresentmentPriceRangesArgs = { - presentmentCurrencies?: Maybe> - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe -} - -/** - * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. - * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). - */ -export type ProductVariantBySelectedOptionsArgs = { - selectedOptions: Array -} - -/** - * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. - * For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). - */ -export type ProductVariantsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe -} - -/** The set of valid sort keys for the ProductCollection query. */ -export enum ProductCollectionSortKeys { - /** Sort by the `title` value. */ - Title = 'TITLE', - /** Sort by the `price` value. */ - Price = 'PRICE', - /** Sort by the `best-selling` value. */ - BestSelling = 'BEST_SELLING', - /** Sort by the `created` value. */ - Created = 'CREATED', - /** Sort by the `id` value. */ - Id = 'ID', - /** Sort by the `manual` value. */ - Manual = 'MANUAL', - /** Sort by the `collection-default` value. */ - CollectionDefault = 'COLLECTION_DEFAULT', - /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. - */ - Relevance = 'RELEVANCE', -} - -/** An auto-generated type for paginating through multiple Products. */ -export type ProductConnection = { - __typename?: 'ProductConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** An auto-generated type which holds one Product and a cursor during pagination. */ -export type ProductEdge = { - __typename?: 'ProductEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of ProductEdge. */ - node: Product -} - -/** The set of valid sort keys for the ProductImage query. */ -export enum ProductImageSortKeys { - /** Sort by the `created_at` value. */ - CreatedAt = 'CREATED_AT', - /** Sort by the `position` value. */ - Position = 'POSITION', - /** Sort by the `id` value. */ - Id = 'ID', - /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. - */ - Relevance = 'RELEVANCE', -} - -/** The set of valid sort keys for the ProductMedia query. */ -export enum ProductMediaSortKeys { - /** Sort by the `position` value. */ - Position = 'POSITION', - /** Sort by the `id` value. */ - Id = 'ID', - /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. - */ - Relevance = 'RELEVANCE', -} - -/** - * Product property names like "Size", "Color", and "Material" that the customers can select. - * Variants are selected based on permutations of these options. - * 255 characters limit each. - */ -export type ProductOption = Node & { - __typename?: 'ProductOption' - /** Globally unique identifier. */ - id: Scalars['ID'] - /** The product option’s name. */ - name: Scalars['String'] - /** The corresponding value to the product option name. */ - values: Array -} - -/** The price range of the product. */ -export type ProductPriceRange = { - __typename?: 'ProductPriceRange' - /** The highest variant's price. */ - maxVariantPrice: MoneyV2 - /** The lowest variant's price. */ - minVariantPrice: MoneyV2 -} - -/** An auto-generated type for paginating through multiple ProductPriceRanges. */ -export type ProductPriceRangeConnection = { - __typename?: 'ProductPriceRangeConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** An auto-generated type which holds one ProductPriceRange and a cursor during pagination. */ -export type ProductPriceRangeEdge = { - __typename?: 'ProductPriceRangeEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of ProductPriceRangeEdge. */ - node: ProductPriceRange -} - -/** The set of valid sort keys for the Product query. */ -export enum ProductSortKeys { - /** Sort by the `title` value. */ - Title = 'TITLE', - /** Sort by the `product_type` value. */ - ProductType = 'PRODUCT_TYPE', - /** Sort by the `vendor` value. */ - Vendor = 'VENDOR', - /** Sort by the `updated_at` value. */ - UpdatedAt = 'UPDATED_AT', - /** Sort by the `created_at` value. */ - CreatedAt = 'CREATED_AT', - /** Sort by the `best_selling` value. */ - BestSelling = 'BEST_SELLING', - /** Sort by the `price` value. */ - Price = 'PRICE', - /** Sort by the `id` value. */ - Id = 'ID', - /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. - */ - Relevance = 'RELEVANCE', -} - -/** A product variant represents a different version of a product, such as differing sizes or differing colors. */ -export type ProductVariant = Node & - HasMetafields & { - __typename?: 'ProductVariant' - /** - * Indicates if the product variant is in stock. - * @deprecated Use `availableForSale` instead - */ - available?: Maybe - /** Indicates if the product variant is available for sale. */ - availableForSale: Scalars['Boolean'] - /** - * The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPrice` is higher than `price`. - * @deprecated Use `compareAtPriceV2` instead - */ - compareAtPrice?: Maybe - /** The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPriceV2` is higher than `priceV2`. */ - compareAtPriceV2?: Maybe - /** Whether a product is out of stock but still available for purchase (used for backorders). */ - currentlyNotInStock: Scalars['Boolean'] - /** Globally unique identifier. */ - id: Scalars['ID'] - /** Image associated with the product variant. This field falls back to the product image if no image is available. */ - image?: Maybe - /** The metafield associated with the resource. */ - metafield?: Maybe - /** A paginated list of metafields associated with the resource. */ - metafields: MetafieldConnection - /** List of prices and compare-at prices in the presentment currencies for this shop. */ - presentmentPrices: ProductVariantPricePairConnection - /** List of unit prices in the presentment currencies for this shop. */ - presentmentUnitPrices: MoneyV2Connection - /** - * The product variant’s price. - * @deprecated Use `priceV2` instead - */ - price: Scalars['Money'] - /** The product variant’s price. */ - priceV2: MoneyV2 - /** The product object that the product variant belongs to. */ - product: Product - /** The total sellable quantity of the variant for online sales channels. */ - quantityAvailable?: Maybe - /** Whether a customer needs to provide a shipping address when placing an order for the product variant. */ - requiresShipping: Scalars['Boolean'] - /** List of product options applied to the variant. */ - selectedOptions: Array - /** The SKU (stock keeping unit) associated with the variant. */ - sku?: Maybe - /** The product variant’s title. */ - title: Scalars['String'] - /** The unit price value for the variant based on the variant's measurement. */ - unitPrice?: Maybe - /** The unit price measurement for the variant. */ - unitPriceMeasurement?: Maybe - /** The weight of the product variant in the unit system specified with `weight_unit`. */ - weight?: Maybe - /** Unit of measurement for weight. */ - weightUnit: WeightUnit - } - -/** A product variant represents a different version of a product, such as differing sizes or differing colors. */ -export type ProductVariantImageArgs = { - maxWidth?: Maybe - maxHeight?: Maybe - crop?: Maybe - scale?: Maybe -} - -/** A product variant represents a different version of a product, such as differing sizes or differing colors. */ -export type ProductVariantMetafieldArgs = { - namespace: Scalars['String'] - key: Scalars['String'] -} - -/** A product variant represents a different version of a product, such as differing sizes or differing colors. */ -export type ProductVariantMetafieldsArgs = { - namespace?: Maybe - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe -} - -/** A product variant represents a different version of a product, such as differing sizes or differing colors. */ -export type ProductVariantPresentmentPricesArgs = { - presentmentCurrencies?: Maybe> - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe -} - -/** A product variant represents a different version of a product, such as differing sizes or differing colors. */ -export type ProductVariantPresentmentUnitPricesArgs = { - presentmentCurrencies?: Maybe> - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe -} - -/** An auto-generated type for paginating through multiple ProductVariants. */ -export type ProductVariantConnection = { - __typename?: 'ProductVariantConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** An auto-generated type which holds one ProductVariant and a cursor during pagination. */ -export type ProductVariantEdge = { - __typename?: 'ProductVariantEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of ProductVariantEdge. */ - node: ProductVariant -} - -/** The compare-at price and price of a variant sharing a currency. */ -export type ProductVariantPricePair = { - __typename?: 'ProductVariantPricePair' - /** The compare-at price of the variant with associated currency. */ - compareAtPrice?: Maybe - /** The price of the variant with associated currency. */ - price: MoneyV2 -} - -/** An auto-generated type for paginating through multiple ProductVariantPricePairs. */ -export type ProductVariantPricePairConnection = { - __typename?: 'ProductVariantPricePairConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo -} - -/** An auto-generated type which holds one ProductVariantPricePair and a cursor during pagination. */ -export type ProductVariantPricePairEdge = { - __typename?: 'ProductVariantPricePairEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of ProductVariantPricePairEdge. */ - node: ProductVariantPricePair -} - -/** The set of valid sort keys for the ProductVariant query. */ -export enum ProductVariantSortKeys { - /** Sort by the `title` value. */ - Title = 'TITLE', - /** Sort by the `sku` value. */ - Sku = 'SKU', - /** Sort by the `position` value. */ - Position = 'POSITION', - /** Sort by the `id` value. */ - Id = 'ID', - /** - * During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - * results by relevance to the search term(s). When no search query is specified, this sort key is not - * deterministic and should not be used. - */ - Relevance = 'RELEVANCE', -} - -/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ -export type QueryRoot = { - __typename?: 'QueryRoot' - /** List of the shop's articles. */ - articles: ArticleConnection - /** Find a blog by its handle. */ - blogByHandle?: Maybe - /** List of the shop's blogs. */ - blogs: BlogConnection - /** Find a collection by its handle. */ - collectionByHandle?: Maybe - /** List of the shop’s collections. */ - collections: CollectionConnection - /** Find a customer by its access token. */ - customer?: Maybe - node?: Maybe - nodes: Array> - /** Find a page by its handle. */ - pageByHandle?: Maybe - /** List of the shop's pages. */ - pages: PageConnection - /** Find a product by its handle. */ - productByHandle?: Maybe - /** - * Find recommended products related to a given `product_id`. - * To learn more about how recommendations are generated, see - * [*Showing product recommendations on product pages*](https://help.shopify.com/themes/development/recommended-products). - */ - productRecommendations?: Maybe> - /** - * Tags added to products. - * Additional access scope required: unauthenticated_read_product_tags. - */ - productTags: StringConnection - /** List of product types for the shop's products that are published to your app. */ - productTypes: StringConnection - /** List of the shop’s products. */ - products: ProductConnection - /** The list of public Storefront API versions, including supported, release candidate and unstable versions. */ - publicApiVersions: Array - /** The shop associated with the storefront access token. */ - shop: Shop -} - -/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ -export type QueryRootArticlesArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe -} - -/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ -export type QueryRootBlogByHandleArgs = { - handle: Scalars['String'] -} - -/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ -export type QueryRootBlogsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe -} - -/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ -export type QueryRootCollectionByHandleArgs = { - handle: Scalars['String'] -} - -/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ -export type QueryRootCollectionsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe -} - -/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ -export type QueryRootCustomerArgs = { - customerAccessToken: Scalars['String'] -} - -/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ -export type QueryRootNodeArgs = { +export type MutationStaffDeleteArgs = { id: Scalars['ID'] } -/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ -export type QueryRootNodesArgs = { - ids: Array +export type MutationStaffBulkDeleteArgs = { + ids: Array> } -/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ -export type QueryRootPageByHandleArgs = { - handle: Scalars['String'] +export type MutationUserAvatarUpdateArgs = { + image: Scalars['Upload'] } -/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ -export type QueryRootPagesArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe +export type MutationUserBulkSetActiveArgs = { + ids: Array> + isActive: Scalars['Boolean'] } -/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ -export type QueryRootProductByHandleArgs = { - handle: Scalars['String'] +export type MutationPermissionGroupCreateArgs = { + input: PermissionGroupCreateInput } -/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ -export type QueryRootProductRecommendationsArgs = { - productId: Scalars['ID'] -} - -/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ -export type QueryRootProductTagsArgs = { - first: Scalars['Int'] -} - -/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ -export type QueryRootProductTypesArgs = { - first: Scalars['Int'] -} - -/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ -export type QueryRootProductsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe -} - -/** SEO information. */ -export type Seo = { - __typename?: 'SEO' - /** The meta description. */ - description?: Maybe - /** The SEO title. */ - title?: Maybe -} - -/** - * Script discount applications capture the intentions of a discount that - * was created by a Shopify Script. - */ -export type ScriptDiscountApplication = DiscountApplication & { - __typename?: 'ScriptDiscountApplication' - /** The method by which the discount's value is allocated to its entitled items. */ - allocationMethod: DiscountApplicationAllocationMethod - /** - * The description of the application as defined by the Script. - * @deprecated Use `title` instead - */ - description: Scalars['String'] - /** Which lines of targetType that the discount is allocated over. */ - targetSelection: DiscountApplicationTargetSelection - /** The type of line that the discount is applicable towards. */ - targetType: DiscountApplicationTargetType - /** The title of the application as defined by the Script. */ - title: Scalars['String'] - /** The value of the discount application. */ - value: PricingValue -} - -/** - * Properties used by customers to select a product variant. - * Products can have multiple options, like different sizes or colors. - */ -export type SelectedOption = { - __typename?: 'SelectedOption' - /** The product option’s name. */ - name: Scalars['String'] - /** The product option’s value. */ - value: Scalars['String'] -} - -/** Specifies the input fields required for a selected option. */ -export type SelectedOptionInput = { - /** The product option’s name. */ - name: Scalars['String'] - /** The product option’s value. */ - value: Scalars['String'] -} - -/** A shipping rate to be applied to a checkout. */ -export type ShippingRate = { - __typename?: 'ShippingRate' - /** Human-readable unique identifier for this shipping rate. */ - handle: Scalars['String'] - /** - * Price of this shipping rate. - * @deprecated Use `priceV2` instead - */ - price: Scalars['Money'] - /** Price of this shipping rate. */ - priceV2: MoneyV2 - /** Title of this shipping rate. */ - title: Scalars['String'] -} - -/** Shop represents a collection of the general settings and information about the shop. */ -export type Shop = { - __typename?: 'Shop' - /** - * List of the shop' articles. - * @deprecated Use `QueryRoot.articles` instead. - */ - articles: ArticleConnection - /** - * List of the shop' blogs. - * @deprecated Use `QueryRoot.blogs` instead. - */ - blogs: BlogConnection - /** - * Find a collection by its handle. - * @deprecated Use `QueryRoot.collectionByHandle` instead. - */ - collectionByHandle?: Maybe - /** - * List of the shop’s collections. - * @deprecated Use `QueryRoot.collections` instead. - */ - collections: CollectionConnection - /** - * The three-letter code for the currency that the shop accepts. - * @deprecated Use `paymentSettings` instead - */ - currencyCode: CurrencyCode - /** A description of the shop. */ - description?: Maybe - /** A string representing the way currency is formatted when the currency isn’t specified. */ - moneyFormat: Scalars['String'] - /** The shop’s name. */ - name: Scalars['String'] - /** Settings related to payments. */ - paymentSettings: PaymentSettings - /** The shop’s primary domain. */ - primaryDomain: Domain - /** The shop’s privacy policy. */ - privacyPolicy?: Maybe - /** - * Find a product by its handle. - * @deprecated Use `QueryRoot.productByHandle` instead. - */ - productByHandle?: Maybe - /** - * A list of tags that have been added to products. - * Additional access scope required: unauthenticated_read_product_tags. - * @deprecated Use `QueryRoot.productTags` instead. - */ - productTags: StringConnection - /** - * List of the shop’s product types. - * @deprecated Use `QueryRoot.productTypes` instead. - */ - productTypes: StringConnection - /** - * List of the shop’s products. - * @deprecated Use `QueryRoot.products` instead. - */ - products: ProductConnection - /** The shop’s refund policy. */ - refundPolicy?: Maybe - /** The shop’s shipping policy. */ - shippingPolicy?: Maybe - /** Countries that the shop ships to. */ - shipsToCountries: Array - /** - * The shop’s Shopify Payments account id. - * @deprecated Use `paymentSettings` instead - */ - shopifyPaymentsAccountId?: Maybe - /** The shop’s terms of service. */ - termsOfService?: Maybe -} - -/** Shop represents a collection of the general settings and information about the shop. */ -export type ShopArticlesArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe -} - -/** Shop represents a collection of the general settings and information about the shop. */ -export type ShopBlogsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe -} - -/** Shop represents a collection of the general settings and information about the shop. */ -export type ShopCollectionByHandleArgs = { - handle: Scalars['String'] -} - -/** Shop represents a collection of the general settings and information about the shop. */ -export type ShopCollectionsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe -} - -/** Shop represents a collection of the general settings and information about the shop. */ -export type ShopProductByHandleArgs = { - handle: Scalars['String'] -} - -/** Shop represents a collection of the general settings and information about the shop. */ -export type ShopProductTagsArgs = { - first: Scalars['Int'] -} - -/** Shop represents a collection of the general settings and information about the shop. */ -export type ShopProductTypesArgs = { - first: Scalars['Int'] -} - -/** Shop represents a collection of the general settings and information about the shop. */ -export type ShopProductsArgs = { - first?: Maybe - after?: Maybe - last?: Maybe - before?: Maybe - reverse?: Maybe - sortKey?: Maybe - query?: Maybe -} - -/** Policy that a merchant has configured for their store, such as their refund or privacy policy. */ -export type ShopPolicy = Node & { - __typename?: 'ShopPolicy' - /** Policy text, maximum size of 64kb. */ - body: Scalars['String'] - /** Policy’s handle. */ - handle: Scalars['String'] - /** Globally unique identifier. */ +export type MutationPermissionGroupUpdateArgs = { id: Scalars['ID'] - /** Policy’s title. */ - title: Scalars['String'] - /** Public URL to the policy. */ - url: Scalars['URL'] + input: PermissionGroupUpdateInput } -/** An auto-generated type for paginating through multiple Strings. */ -export type StringConnection = { - __typename?: 'StringConnection' - /** A list of edges. */ - edges: Array - /** Information to aid in pagination. */ - pageInfo: PageInfo +export type MutationPermissionGroupDeleteArgs = { + id: Scalars['ID'] } -/** An auto-generated type which holds one String and a cursor during pagination. */ -export type StringEdge = { - __typename?: 'StringEdge' - /** A cursor for use in pagination. */ - cursor: Scalars['String'] - /** The item at the end of StringEdge. */ - node: Scalars['String'] -} - -/** - * Specifies the fields required to complete a checkout with - * a tokenized payment. - */ -export type TokenizedPaymentInput = { - /** The amount of the payment. */ - amount: Scalars['Money'] - /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. */ - idempotencyKey: Scalars['String'] - /** The billing address for the payment. */ - billingAddress: MailingAddressInput - /** The type of payment token. */ - type: Scalars['String'] - /** A simple string or JSON containing the required payment data for the tokenized payment. */ - paymentData: Scalars['String'] - /** Executes the payment in test mode if possible. Defaults to `false`. */ - test?: Maybe - /** Public Hash Key used for AndroidPay payments only. */ - identifier?: Maybe -} - -/** - * Specifies the fields required to complete a checkout with - * a tokenized payment. - */ -export type TokenizedPaymentInputV2 = { - /** The amount and currency of the payment. */ - paymentAmount: MoneyInput - /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. */ - idempotencyKey: Scalars['String'] - /** The billing address for the payment. */ - billingAddress: MailingAddressInput - /** A simple string or JSON containing the required payment data for the tokenized payment. */ - paymentData: Scalars['String'] - /** Whether to execute the payment in test mode, if possible. Test mode is not supported in production stores. Defaults to `false`. */ - test?: Maybe - /** Public Hash Key used for AndroidPay payments only. */ - identifier?: Maybe - /** The type of payment token. */ - type: Scalars['String'] -} - -/** - * Specifies the fields required to complete a checkout with - * a tokenized payment. - */ -export type TokenizedPaymentInputV3 = { - /** The amount and currency of the payment. */ - paymentAmount: MoneyInput - /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. */ - idempotencyKey: Scalars['String'] - /** The billing address for the payment. */ - billingAddress: MailingAddressInput - /** A simple string or JSON containing the required payment data for the tokenized payment. */ - paymentData: Scalars['String'] - /** Whether to execute the payment in test mode, if possible. Test mode is not supported in production stores. Defaults to `false`. */ - test?: Maybe - /** Public Hash Key used for AndroidPay payments only. */ - identifier?: Maybe - /** The type of payment token. */ - type: PaymentTokenType -} - -/** An object representing exchange of money for a product or service. */ -export type Transaction = { - __typename?: 'Transaction' +/** Creates a new webhook subscription. */ +export type WebhookCreate = { + __typename?: 'WebhookCreate' /** - * The amount of money that the transaction was for. - * @deprecated Use `amountV2` instead + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. */ - amount: Scalars['Money'] - /** The amount of money that the transaction was for. */ - amountV2: MoneyV2 - /** The kind of the transaction. */ - kind: TransactionKind - /** - * The status of the transaction. - * @deprecated Use `statusV2` instead - */ - status: TransactionStatus - /** The status of the transaction. */ - statusV2?: Maybe - /** Whether the transaction was done in test mode or not. */ - test: Scalars['Boolean'] -} - -export enum TransactionKind { - Sale = 'SALE', - Capture = 'CAPTURE', - Authorization = 'AUTHORIZATION', - EmvAuthorization = 'EMV_AUTHORIZATION', - Change = 'CHANGE', -} - -export enum TransactionStatus { - Pending = 'PENDING', - Success = 'SUCCESS', - Failure = 'FAILURE', - Error = 'ERROR', -} - -/** The measurement used to calculate a unit price for a product variant (e.g. $9.99 / 100ml). */ -export type UnitPriceMeasurement = { - __typename?: 'UnitPriceMeasurement' - /** The type of unit of measurement for the unit price measurement. */ - measuredType?: Maybe - /** The quantity unit for the unit price measurement. */ - quantityUnit?: Maybe - /** The quantity value for the unit price measurement. */ - quantityValue: Scalars['Float'] - /** The reference unit for the unit price measurement. */ - referenceUnit?: Maybe - /** The reference value for the unit price measurement. */ - referenceValue: Scalars['Int'] -} - -/** The accepted types of unit of measurement. */ -export enum UnitPriceMeasurementMeasuredType { - /** Unit of measurements representing volumes. */ - Volume = 'VOLUME', - /** Unit of measurements representing weights. */ - Weight = 'WEIGHT', - /** Unit of measurements representing lengths. */ - Length = 'LENGTH', - /** Unit of measurements representing areas. */ - Area = 'AREA', -} - -/** The valid units of measurement for a unit price measurement. */ -export enum UnitPriceMeasurementMeasuredUnit { - /** 1000 milliliters equals 1 liter. */ - Ml = 'ML', - /** 100 centiliters equals 1 liter. */ - Cl = 'CL', - /** Metric system unit of volume. */ - L = 'L', - /** 1 cubic meter equals 1000 liters. */ - M3 = 'M3', - /** 1000 milligrams equals 1 gram. */ - Mg = 'MG', - /** Metric system unit of weight. */ - G = 'G', - /** 1 kilogram equals 1000 grams. */ - Kg = 'KG', - /** 1000 millimeters equals 1 meter. */ - Mm = 'MM', - /** 100 centimeters equals 1 meter. */ - Cm = 'CM', - /** Metric system unit of length. */ - M = 'M', - /** Metric system unit of area. */ - M2 = 'M2', + errors: Array + webhookErrors: Array + webhook?: Maybe } /** Represents an error in the input of a mutation. */ -export type UserError = DisplayableError & { - __typename?: 'UserError' - /** Path to the input field which caused the error. */ - field?: Maybe> +export type Error = { + __typename?: 'Error' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe /** The error message. */ + message?: Maybe +} + +export type WebhookError = { + __typename?: 'WebhookError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: WebhookErrorCode +} + +/** An enumeration. */ +export enum WebhookErrorCode { + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', + Unique = 'UNIQUE', +} + +export type WebhookCreateInput = { + /** The name of the webhook. */ + name?: Maybe + /** The url to receive the payload. */ + targetUrl?: Maybe + /** The events that webhook wants to subscribe. */ + events?: Maybe>> + /** ID of the app to which webhook belongs. */ + app?: Maybe + /** Determine if webhook will be set active or not. */ + isActive?: Maybe + /** The secret key used to create a hash signature with each payload. */ + secretKey?: Maybe +} + +/** Deletes a webhook subscription. */ +export type WebhookDelete = { + __typename?: 'WebhookDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + webhookErrors: Array + webhook?: Maybe +} + +/** Updates a webhook subscription. */ +export type WebhookUpdate = { + __typename?: 'WebhookUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + webhookErrors: Array + webhook?: Maybe +} + +export type WebhookUpdateInput = { + /** The new name of the webhook. */ + name?: Maybe + /** The url to receive the payload. */ + targetUrl?: Maybe + /** The events that webhook wants to subscribe. */ + events?: Maybe>> + /** ID of the app to which webhook belongs. */ + app?: Maybe + /** Determine if webhook will be set active or not. */ + isActive?: Maybe + /** Use to create a hash signature with each payload. */ + secretKey?: Maybe +} + +/** Creates new warehouse. */ +export type WarehouseCreate = { + __typename?: 'WarehouseCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + warehouseErrors: Array + warehouse?: Maybe +} + +export type WarehouseError = { + __typename?: 'WarehouseError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: WarehouseErrorCode +} + +/** An enumeration. */ +export enum WarehouseErrorCode { + AlreadyExists = 'ALREADY_EXISTS', + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', + Unique = 'UNIQUE', +} + +export type WarehouseCreateInput = { + /** Warehouse slug. */ + slug?: Maybe + /** Company name. */ + companyName?: Maybe + /** The email address of the warehouse. */ + email?: Maybe + /** Warehouse name. */ + name: Scalars['String'] + /** Address of the warehouse. */ + address: WarehouseAddressInput + /** Shipping zones supported by the warehouse. */ + shippingZones?: Maybe>> +} + +export type WarehouseAddressInput = { + /** Address. */ + streetAddress1: Scalars['String'] + /** Address. */ + streetAddress2?: Maybe + /** City. */ + city: Scalars['String'] + /** District. */ + cityArea?: Maybe + /** Postal code. */ + postalCode?: Maybe + /** Country. */ + country: CountryCode + /** State or province. */ + countryArea?: Maybe + /** Phone number. */ + phone?: Maybe +} + +/** Updates given warehouse. */ +export type WarehouseUpdate = { + __typename?: 'WarehouseUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + warehouseErrors: Array + warehouse?: Maybe +} + +export type WarehouseUpdateInput = { + /** Warehouse slug. */ + slug?: Maybe + /** Company name. */ + companyName?: Maybe + /** The email address of the warehouse. */ + email?: Maybe + /** Warehouse name. */ + name?: Maybe + /** Address of the warehouse. */ + address?: Maybe +} + +/** Deletes selected warehouse. */ +export type WarehouseDelete = { + __typename?: 'WarehouseDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + warehouseErrors: Array + warehouse?: Maybe +} + +/** Add shipping zone to given warehouse. */ +export type WarehouseShippingZoneAssign = { + __typename?: 'WarehouseShippingZoneAssign' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + warehouseErrors: Array + warehouse?: Maybe +} + +/** Remove shipping zone from given warehouse. */ +export type WarehouseShippingZoneUnassign = { + __typename?: 'WarehouseShippingZoneUnassign' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + warehouseErrors: Array + warehouse?: Maybe +} + +/** Creates a new staff notification recipient. */ +export type StaffNotificationRecipientCreate = { + __typename?: 'StaffNotificationRecipientCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + shopErrors: Array + staffNotificationRecipient?: Maybe +} + +export type ShopError = { + __typename?: 'ShopError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: ShopErrorCode +} + +/** An enumeration. */ +export enum ShopErrorCode { + AlreadyExists = 'ALREADY_EXISTS', + CannotFetchTaxRates = 'CANNOT_FETCH_TAX_RATES', + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', + Unique = 'UNIQUE', +} + +export type StaffNotificationRecipientInput = { + /** The ID of the user subscribed to email notifications.. */ + user?: Maybe + /** Email address of a user subscribed to email notifications. */ + email?: Maybe + /** Determines if a notification active. */ + active?: Maybe +} + +/** Updates a staff notification recipient. */ +export type StaffNotificationRecipientUpdate = { + __typename?: 'StaffNotificationRecipientUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + shopErrors: Array + staffNotificationRecipient?: Maybe +} + +/** Delete staff notification recipient. */ +export type StaffNotificationRecipientDelete = { + __typename?: 'StaffNotificationRecipientDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + shopErrors: Array + staffNotificationRecipient?: Maybe +} + +/** Updates site domain of the shop. */ +export type ShopDomainUpdate = { + __typename?: 'ShopDomainUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Updated shop. */ + shop?: Maybe + shopErrors: Array +} + +export type SiteDomainInput = { + /** Domain name for shop. */ + domain?: Maybe + /** Shop site name. */ + name?: Maybe +} + +/** Updates shop settings. */ +export type ShopSettingsUpdate = { + __typename?: 'ShopSettingsUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Updated shop. */ + shop?: Maybe + shopErrors: Array +} + +export type ShopSettingsInput = { + /** Header text. */ + headerText?: Maybe + /** SEO description. */ + description?: Maybe + /** Include taxes in prices. */ + includeTaxesInPrices?: Maybe + /** Display prices with tax in store. */ + displayGrossPrices?: Maybe + /** Charge taxes on shipping. */ + chargeTaxesOnShipping?: Maybe + /** Enable inventory tracking. */ + trackInventoryByDefault?: Maybe + /** Default weight unit. */ + defaultWeightUnit?: Maybe + /** Enable automatic fulfillment for all digital products. */ + automaticFulfillmentDigitalProducts?: Maybe + /** Default number of max downloads per digital content URL. */ + defaultDigitalMaxDownloads?: Maybe + /** Default number of days which digital content URL will be valid. */ + defaultDigitalUrlValidDays?: Maybe + /** Default email sender's name. */ + defaultMailSenderName?: Maybe + /** Default email sender's address. */ + defaultMailSenderAddress?: Maybe + /** URL of a view where customers can set their password. */ + customerSetPasswordUrl?: Maybe +} + +/** Fetch tax rates. */ +export type ShopFetchTaxRates = { + __typename?: 'ShopFetchTaxRates' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Updated shop. */ + shop?: Maybe + shopErrors: Array +} + +/** Creates/Updates translations for Shop Settings. */ +export type ShopSettingsTranslate = { + __typename?: 'ShopSettingsTranslate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Updated shop. */ + shop?: Maybe + translationErrors: Array +} + +export type TranslationError = { + __typename?: 'TranslationError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: TranslationErrorCode +} + +/** An enumeration. */ +export enum TranslationErrorCode { + GraphqlError = 'GRAPHQL_ERROR', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', +} + +export type ShopSettingsTranslationInput = { + headerText?: Maybe + description?: Maybe +} + +/** Update the shop's address. If the `null` value is passed, the currently selected address will be deleted. */ +export type ShopAddressUpdate = { + __typename?: 'ShopAddressUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Updated shop. */ + shop?: Maybe + shopErrors: Array +} + +/** Update shop order settings. */ +export type OrderSettingsUpdate = { + __typename?: 'OrderSettingsUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Order settings. */ + orderSettings?: Maybe + orderSettingsErrors: Array +} + +export type OrderSettingsError = { + __typename?: 'OrderSettingsError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: OrderSettingsErrorCode +} + +/** An enumeration. */ +export enum OrderSettingsErrorCode { + Invalid = 'INVALID', +} + +export type OrderSettingsUpdateInput = { + /** When disabled, all new orders from checkout will be marked as unconfirmed. When enabled orders from checkout will become unfulfilled immediately. */ + automaticallyConfirmAllNewOrders: Scalars['Boolean'] +} + +/** Manage shipping method's availability in channels. */ +export type ShippingMethodChannelListingUpdate = { + __typename?: 'ShippingMethodChannelListingUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated shipping method instance. */ + shippingMethod?: Maybe + shippingErrors: Array +} + +export type ShippingError = { + __typename?: 'ShippingError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: ShippingErrorCode + /** List of warehouse IDs which causes the error. */ + warehouses?: Maybe> + /** List of channels IDs which causes the error. */ + channels?: Maybe> +} + +/** An enumeration. */ +export enum ShippingErrorCode { + AlreadyExists = 'ALREADY_EXISTS', + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + MaxLessThanMin = 'MAX_LESS_THAN_MIN', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', + Unique = 'UNIQUE', + DuplicatedInputItem = 'DUPLICATED_INPUT_ITEM', +} + +export type ShippingMethodChannelListingInput = { + /** List of channels to which the shipping method should be assigned. */ + addChannels?: Maybe> + /** List of channels from which the shipping method should be unassigned. */ + removeChannels?: Maybe> +} + +export type ShippingMethodChannelListingAddInput = { + /** ID of a channel. */ + channelId: Scalars['ID'] + /** Shipping price of the shipping method in this channel. */ + price?: Maybe + /** Minimum order price to use this shipping method. */ + minimumOrderPrice?: Maybe + /** Maximum order price to use this shipping method. */ + maximumOrderPrice?: Maybe +} + +/** Creates a new shipping price. */ +export type ShippingPriceCreate = { + __typename?: 'ShippingPriceCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A shipping zone to which the shipping method belongs. */ + shippingZone?: Maybe + shippingMethod?: Maybe + shippingErrors: Array +} + +export type ShippingPriceInput = { + /** Name of the shipping method. */ + name?: Maybe + /** Minimum order weight to use this shipping method. */ + minimumOrderWeight?: Maybe + /** Maximum order weight to use this shipping method. */ + maximumOrderWeight?: Maybe + /** Maximum number of days for delivery. */ + maximumDeliveryDays?: Maybe + /** Minimal number of days for delivery. */ + minimumDeliveryDays?: Maybe + /** Shipping type: price or weight based. */ + type?: Maybe + /** Shipping zone this method belongs to. */ + shippingZone?: Maybe + /** Postal code rules to add. */ + addPostalCodeRules?: Maybe> + /** Postal code rules to delete. */ + deletePostalCodeRules?: Maybe> + /** Inclusion type for currently assigned postal code rules. */ + inclusionType?: Maybe +} + +export type ShippingPostalCodeRulesCreateInputRange = { + /** Start range of the postal code. */ + start: Scalars['String'] + /** End range of the postal code. */ + end?: Maybe +} + +/** Deletes a shipping price. */ +export type ShippingPriceDelete = { + __typename?: 'ShippingPriceDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A shipping method to delete. */ + shippingMethod?: Maybe + /** A shipping zone to which the shipping method belongs. */ + shippingZone?: Maybe + shippingErrors: Array +} + +/** Deletes shipping prices. */ +export type ShippingPriceBulkDelete = { + __typename?: 'ShippingPriceBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + shippingErrors: Array +} + +/** Updates a new shipping price. */ +export type ShippingPriceUpdate = { + __typename?: 'ShippingPriceUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A shipping zone to which the shipping method belongs. */ + shippingZone?: Maybe + shippingMethod?: Maybe + shippingErrors: Array +} + +/** Creates/Updates translations for shipping method. */ +export type ShippingPriceTranslate = { + __typename?: 'ShippingPriceTranslate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + translationErrors: Array + shippingMethod?: Maybe +} + +export type NameTranslationInput = { + name?: Maybe +} + +/** Exclude products from shipping price. */ +export type ShippingPriceExcludeProducts = { + __typename?: 'ShippingPriceExcludeProducts' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A shipping method with new list of excluded products. */ + shippingMethod?: Maybe + shippingErrors: Array +} + +export type ShippingPriceExcludeProductsInput = { + /** List of products which will be excluded. */ + products: Array> +} + +/** Remove product from excluded list for shipping price. */ +export type ShippingPriceRemoveProductFromExclude = { + __typename?: 'ShippingPriceRemoveProductFromExclude' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A shipping method with new list of excluded products. */ + shippingMethod?: Maybe + shippingErrors: Array +} + +/** Creates a new shipping zone. */ +export type ShippingZoneCreate = { + __typename?: 'ShippingZoneCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + shippingErrors: Array + shippingZone?: Maybe +} + +export type ShippingZoneCreateInput = { + /** Shipping zone's name. Visible only to the staff. */ + name?: Maybe + /** Description of the shipping zone. */ + description?: Maybe + /** List of countries in this shipping zone. */ + countries?: Maybe>> + /** Default shipping zone will be used for countries not covered by other zones. */ + default?: Maybe + /** List of warehouses to assign to a shipping zone */ + addWarehouses?: Maybe>> + /** List of channels to assign to the shipping zone. */ + addChannels?: Maybe> +} + +/** Deletes a shipping zone. */ +export type ShippingZoneDelete = { + __typename?: 'ShippingZoneDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + shippingErrors: Array + shippingZone?: Maybe +} + +/** Deletes shipping zones. */ +export type ShippingZoneBulkDelete = { + __typename?: 'ShippingZoneBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + shippingErrors: Array +} + +/** Updates a new shipping zone. */ +export type ShippingZoneUpdate = { + __typename?: 'ShippingZoneUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + shippingErrors: Array + shippingZone?: Maybe +} + +export type ShippingZoneUpdateInput = { + /** Shipping zone's name. Visible only to the staff. */ + name?: Maybe + /** Description of the shipping zone. */ + description?: Maybe + /** List of countries in this shipping zone. */ + countries?: Maybe>> + /** Default shipping zone will be used for countries not covered by other zones. */ + default?: Maybe + /** List of warehouses to assign to a shipping zone */ + addWarehouses?: Maybe>> + /** List of channels to assign to the shipping zone. */ + addChannels?: Maybe> + /** List of warehouses to unassign from a shipping zone */ + removeWarehouses?: Maybe>> + /** List of channels to unassign from the shipping zone. */ + removeChannels?: Maybe> +} + +/** Assign attributes to a given product type. */ +export type ProductAttributeAssign = { + __typename?: 'ProductAttributeAssign' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** The updated product type. */ + productType?: Maybe + productErrors: Array +} + +export type ProductError = { + __typename?: 'ProductError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: ProductErrorCode + /** List of attributes IDs which causes the error. */ + attributes?: Maybe> + /** List of attribute values IDs which causes the error. */ + values?: Maybe> +} + +/** An enumeration. */ +export enum ProductErrorCode { + AlreadyExists = 'ALREADY_EXISTS', + AttributeAlreadyAssigned = 'ATTRIBUTE_ALREADY_ASSIGNED', + AttributeCannotBeAssigned = 'ATTRIBUTE_CANNOT_BE_ASSIGNED', + AttributeVariantsDisabled = 'ATTRIBUTE_VARIANTS_DISABLED', + DuplicatedInputItem = 'DUPLICATED_INPUT_ITEM', + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + ProductWithoutCategory = 'PRODUCT_WITHOUT_CATEGORY', + NotProductsImage = 'NOT_PRODUCTS_IMAGE', + NotProductsVariant = 'NOT_PRODUCTS_VARIANT', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', + Unique = 'UNIQUE', + VariantNoDigitalContent = 'VARIANT_NO_DIGITAL_CONTENT', + CannotManageProductWithoutVariant = 'CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT', + ProductNotAssignedToChannel = 'PRODUCT_NOT_ASSIGNED_TO_CHANNEL', + UnsupportedMediaProvider = 'UNSUPPORTED_MEDIA_PROVIDER', +} + +export type ProductAttributeAssignInput = { + /** The ID of the attribute to assign. */ + id: Scalars['ID'] + /** The attribute type to be assigned as. */ + type: ProductAttributeType +} + +export enum ProductAttributeType { + Product = 'PRODUCT', + Variant = 'VARIANT', +} + +/** Un-assign attributes from a given product type. */ +export type ProductAttributeUnassign = { + __typename?: 'ProductAttributeUnassign' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** The updated product type. */ + productType?: Maybe + productErrors: Array +} + +/** Creates a new category. */ +export type CategoryCreate = { + __typename?: 'CategoryCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + productErrors: Array + category?: Maybe +} + +export type CategoryInput = { + /** Category description (JSON). */ + description?: Maybe + /** Category name. */ + name?: Maybe + /** Category slug. */ + slug?: Maybe + /** Search engine optimization fields. */ + seo?: Maybe + /** Background image file. */ + backgroundImage?: Maybe + /** Alt text for a product media. */ + backgroundImageAlt?: Maybe +} + +export type SeoInput = { + /** SEO title. */ + title?: Maybe + /** SEO description. */ + description?: Maybe +} + +/** Deletes a category. */ +export type CategoryDelete = { + __typename?: 'CategoryDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + productErrors: Array + category?: Maybe +} + +/** Deletes categories. */ +export type CategoryBulkDelete = { + __typename?: 'CategoryBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + productErrors: Array +} + +/** Updates a category. */ +export type CategoryUpdate = { + __typename?: 'CategoryUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + productErrors: Array + category?: Maybe +} + +/** Creates/Updates translations for Category. */ +export type CategoryTranslate = { + __typename?: 'CategoryTranslate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + translationErrors: Array + category?: Maybe +} + +export type TranslationInput = { + seoTitle?: Maybe + seoDescription?: Maybe + name?: Maybe + description?: Maybe +} + +/** Adds products to a collection. */ +export type CollectionAddProducts = { + __typename?: 'CollectionAddProducts' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Collection to which products will be added. */ + collection?: Maybe + collectionErrors: Array +} + +export type CollectionError = { + __typename?: 'CollectionError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** List of products IDs which causes the error. */ + products?: Maybe> + /** The error code. */ + code: CollectionErrorCode +} + +/** An enumeration. */ +export enum CollectionErrorCode { + DuplicatedInputItem = 'DUPLICATED_INPUT_ITEM', + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', + Unique = 'UNIQUE', + CannotManageProductWithoutVariant = 'CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT', +} + +/** Creates a new collection. */ +export type CollectionCreate = { + __typename?: 'CollectionCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + collectionErrors: Array + collection?: Maybe +} + +export type CollectionCreateInput = { + /** Informs whether a collection is published. */ + isPublished?: Maybe + /** Name of the collection. */ + name?: Maybe + /** Slug of the collection. */ + slug?: Maybe + /** Description of the collection (JSON). */ + description?: Maybe + /** Background image file. */ + backgroundImage?: Maybe + /** Alt text for an image. */ + backgroundImageAlt?: Maybe + /** Search engine optimization fields. */ + seo?: Maybe + /** Publication date. ISO 8601 standard. */ + publicationDate?: Maybe + /** List of products to be added to the collection. */ + products?: Maybe>> +} + +/** Deletes a collection. */ +export type CollectionDelete = { + __typename?: 'CollectionDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + collectionErrors: Array + collection?: Maybe +} + +/** Reorder the products of a collection. */ +export type CollectionReorderProducts = { + __typename?: 'CollectionReorderProducts' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Collection from which products are reordered. */ + collection?: Maybe + collectionErrors: Array +} + +export type MoveProductInput = { + /** The ID of the product to move. */ + productId: Scalars['ID'] + /** The relative sorting position of the product (from -inf to +inf) starting from the first given product's actual position.1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged. */ + sortOrder?: Maybe +} + +/** Deletes collections. */ +export type CollectionBulkDelete = { + __typename?: 'CollectionBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + collectionErrors: Array +} + +/** Remove products from a collection. */ +export type CollectionRemoveProducts = { + __typename?: 'CollectionRemoveProducts' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Collection from which products will be removed. */ + collection?: Maybe + collectionErrors: Array +} + +/** Updates a collection. */ +export type CollectionUpdate = { + __typename?: 'CollectionUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + collectionErrors: Array + collection?: Maybe +} + +export type CollectionInput = { + /** Informs whether a collection is published. */ + isPublished?: Maybe + /** Name of the collection. */ + name?: Maybe + /** Slug of the collection. */ + slug?: Maybe + /** Description of the collection (JSON). */ + description?: Maybe + /** Background image file. */ + backgroundImage?: Maybe + /** Alt text for an image. */ + backgroundImageAlt?: Maybe + /** Search engine optimization fields. */ + seo?: Maybe + /** Publication date. ISO 8601 standard. */ + publicationDate?: Maybe +} + +/** Creates/Updates translations for collection. */ +export type CollectionTranslate = { + __typename?: 'CollectionTranslate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + translationErrors: Array + collection?: Maybe +} + +/** Manage collection's availability in channels. */ +export type CollectionChannelListingUpdate = { + __typename?: 'CollectionChannelListingUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated collection instance. */ + collection?: Maybe + collectionChannelListingErrors: Array +} + +export type CollectionChannelListingError = { + __typename?: 'CollectionChannelListingError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: ProductErrorCode + /** List of attributes IDs which causes the error. */ + attributes?: Maybe> + /** List of attribute values IDs which causes the error. */ + values?: Maybe> + /** List of channels IDs which causes the error. */ + channels?: Maybe> +} + +export type CollectionChannelListingUpdateInput = { + /** List of channels to which the collection should be assigned. */ + addChannels?: Maybe> + /** List of channels from which the collection should be unassigned. */ + removeChannels?: Maybe> +} + +export type PublishableChannelListingInput = { + /** ID of a channel. */ + channelId: Scalars['ID'] + /** Determines if object is visible to customers. */ + isPublished?: Maybe + /** Publication date. ISO 8601 standard. */ + publicationDate?: Maybe +} + +/** Creates a new product. */ +export type ProductCreate = { + __typename?: 'ProductCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + productErrors: Array + product?: Maybe +} + +export type ProductCreateInput = { + /** List of attributes. */ + attributes?: Maybe> + /** ID of the product's category. */ + category?: Maybe + /** Determine if taxes are being charged for the product. */ + chargeTaxes?: Maybe + /** List of IDs of collections that the product belongs to. */ + collections?: Maybe> + /** Product description (JSON). */ + description?: Maybe + /** Product name. */ + name?: Maybe + /** Product slug. */ + slug?: Maybe + /** Tax rate for enabled tax gateway. */ + taxCode?: Maybe + /** Search engine optimization fields. */ + seo?: Maybe + /** Weight of the Product. */ + weight?: Maybe + /** Defines the product rating value. */ + rating?: Maybe + /** ID of the type that product belongs to. */ + productType: Scalars['ID'] +} + +export type AttributeValueInput = { + /** ID of the selected attribute. */ + id?: Maybe + /** The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created. */ + values?: Maybe>> + /** URL of the file attribute. Every time, a new value is created. */ + file?: Maybe + /** File content type. */ + contentType?: Maybe + /** List of entity IDs that will be used as references. */ + references?: Maybe> + /** Text content in JSON format. */ + richText?: Maybe +} + +/** Deletes a product. */ +export type ProductDelete = { + __typename?: 'ProductDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + productErrors: Array + product?: Maybe +} + +/** Deletes products. */ +export type ProductBulkDelete = { + __typename?: 'ProductBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + productErrors: Array +} + +/** Updates an existing product. */ +export type ProductUpdate = { + __typename?: 'ProductUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + productErrors: Array + product?: Maybe +} + +export type ProductInput = { + /** List of attributes. */ + attributes?: Maybe> + /** ID of the product's category. */ + category?: Maybe + /** Determine if taxes are being charged for the product. */ + chargeTaxes?: Maybe + /** List of IDs of collections that the product belongs to. */ + collections?: Maybe> + /** Product description (JSON). */ + description?: Maybe + /** Product name. */ + name?: Maybe + /** Product slug. */ + slug?: Maybe + /** Tax rate for enabled tax gateway. */ + taxCode?: Maybe + /** Search engine optimization fields. */ + seo?: Maybe + /** Weight of the Product. */ + weight?: Maybe + /** Defines the product rating value. */ + rating?: Maybe +} + +/** Creates/Updates translations for Product. */ +export type ProductTranslate = { + __typename?: 'ProductTranslate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + translationErrors: Array + product?: Maybe +} + +/** Manage product's availability in channels. */ +export type ProductChannelListingUpdate = { + __typename?: 'ProductChannelListingUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated product instance. */ + product?: Maybe + productChannelListingErrors: Array +} + +export type ProductChannelListingError = { + __typename?: 'ProductChannelListingError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: ProductErrorCode + /** List of attributes IDs which causes the error. */ + attributes?: Maybe> + /** List of attribute values IDs which causes the error. */ + values?: Maybe> + /** List of channels IDs which causes the error. */ + channels?: Maybe> + /** List of variants IDs which causes the error. */ + variants?: Maybe> +} + +export type ProductChannelListingUpdateInput = { + /** List of channels to which the product should be assigned or updated. */ + updateChannels?: Maybe> + /** List of channels from which the product should be unassigned. */ + removeChannels?: Maybe> +} + +export type ProductChannelListingAddInput = { + /** ID of a channel. */ + channelId: Scalars['ID'] + /** Determines if object is visible to customers. */ + isPublished?: Maybe + /** Publication date. ISO 8601 standard. */ + publicationDate?: Maybe + /** Determines if product is visible in product listings (doesn't apply to product collections). */ + visibleInListings?: Maybe + /** Determine if product should be available for purchase. */ + isAvailableForPurchase?: Maybe + /** A start date from which a product will be available for purchase. When not set and isAvailable is set to True, the current day is assumed. */ + availableForPurchaseDate?: Maybe + /** List of variants to which the channel should be assigned. */ + addVariants?: Maybe> + /** List of variants from which the channel should be unassigned. */ + removeVariants?: Maybe> +} + +/** Create a media object (image or video URL) associated with product. For image, this mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec */ +export type ProductMediaCreate = { + __typename?: 'ProductMediaCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + product?: Maybe + media?: Maybe + productErrors: Array +} + +export type ProductMediaCreateInput = { + /** Alt text for a product media. */ + alt?: Maybe + /** Represents an image file in a multipart request. */ + image?: Maybe + /** ID of an product. */ + product: Scalars['ID'] + /** Represents an URL to an external media. */ + mediaUrl?: Maybe +} + +/** Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook. */ +export type ProductVariantReorder = { + __typename?: 'ProductVariantReorder' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + product?: Maybe + productErrors: Array +} + +export type ReorderInput = { + /** The ID of the item to move. */ + id: Scalars['ID'] + /** The new relative sorting position of the item (from -inf to +inf). 1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged. */ + sortOrder?: Maybe +} + +/** Deletes a product media. */ +export type ProductMediaDelete = { + __typename?: 'ProductMediaDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + product?: Maybe + media?: Maybe + productErrors: Array +} + +/** Deletes product media. */ +export type ProductMediaBulkDelete = { + __typename?: 'ProductMediaBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + productErrors: Array +} + +/** Changes ordering of the product media. */ +export type ProductMediaReorder = { + __typename?: 'ProductMediaReorder' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + product?: Maybe + media?: Maybe> + productErrors: Array +} + +/** Updates a product media. */ +export type ProductMediaUpdate = { + __typename?: 'ProductMediaUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + product?: Maybe + media?: Maybe + productErrors: Array +} + +export type ProductMediaUpdateInput = { + /** Alt text for a product media. */ + alt?: Maybe +} + +/** Creates a new product type. */ +export type ProductTypeCreate = { + __typename?: 'ProductTypeCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + productErrors: Array + productType?: Maybe +} + +export type ProductTypeInput = { + /** Name of the product type. */ + name?: Maybe + /** Product type slug. */ + slug?: Maybe + /** Determines if product of this type has multiple variants. This option mainly simplifies product management in the dashboard. There is always at least one variant created under the hood. */ + hasVariants?: Maybe + /** List of attributes shared among all product variants. */ + productAttributes?: Maybe>> + /** List of attributes used to distinguish between different variants of a product. */ + variantAttributes?: Maybe>> + /** Determines if shipping is required for products of this variant. */ + isShippingRequired?: Maybe + /** Determines if products are digital. */ + isDigital?: Maybe + /** Weight of the ProductType items. */ + weight?: Maybe + /** Tax rate for enabled tax gateway. */ + taxCode?: Maybe +} + +/** Deletes a product type. */ +export type ProductTypeDelete = { + __typename?: 'ProductTypeDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + productErrors: Array + productType?: Maybe +} + +/** Deletes product types. */ +export type ProductTypeBulkDelete = { + __typename?: 'ProductTypeBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + productErrors: Array +} + +/** Updates an existing product type. */ +export type ProductTypeUpdate = { + __typename?: 'ProductTypeUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + productErrors: Array + productType?: Maybe +} + +/** Reorder the attributes of a product type. */ +export type ProductTypeReorderAttributes = { + __typename?: 'ProductTypeReorderAttributes' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Product type from which attributes are reordered. */ + productType?: Maybe + productErrors: Array +} + +/** Reorder product attribute values. */ +export type ProductReorderAttributeValues = { + __typename?: 'ProductReorderAttributeValues' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Product from which attribute values are reordered. */ + product?: Maybe + productErrors: Array +} + +/** Create new digital content. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec */ +export type DigitalContentCreate = { + __typename?: 'DigitalContentCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + variant?: Maybe + content?: Maybe + productErrors: Array +} + +export type DigitalContentUploadInput = { + /** Use default digital content settings for this product. */ + useDefaultSettings: Scalars['Boolean'] + /** Determines how many times a download link can be accessed by a customer. */ + maxDownloads?: Maybe + /** Determines for how many days a download link is active since it was generated. */ + urlValidDays?: Maybe + /** Overwrite default automatic_fulfillment setting for variant. */ + automaticFulfillment?: Maybe + /** Represents an file in a multipart request. */ + contentFile: Scalars['Upload'] +} + +/** Remove digital content assigned to given variant. */ +export type DigitalContentDelete = { + __typename?: 'DigitalContentDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + variant?: Maybe + productErrors: Array +} + +/** Update digital content. */ +export type DigitalContentUpdate = { + __typename?: 'DigitalContentUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + variant?: Maybe + content?: Maybe + productErrors: Array +} + +export type DigitalContentInput = { + /** Use default digital content settings for this product. */ + useDefaultSettings: Scalars['Boolean'] + /** Determines how many times a download link can be accessed by a customer. */ + maxDownloads?: Maybe + /** Determines for how many days a download link is active since it was generated. */ + urlValidDays?: Maybe + /** Overwrite default automatic_fulfillment setting for variant. */ + automaticFulfillment?: Maybe +} + +/** Generate new URL to digital content. */ +export type DigitalContentUrlCreate = { + __typename?: 'DigitalContentUrlCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + productErrors: Array + digitalContentUrl?: Maybe +} + +export type DigitalContentUrlCreateInput = { + /** Digital content ID which URL will belong to. */ + content: Scalars['ID'] +} + +/** Creates a new variant for a product. */ +export type ProductVariantCreate = { + __typename?: 'ProductVariantCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + productErrors: Array + productVariant?: Maybe +} + +export type ProductVariantCreateInput = { + /** List of attributes specific to this variant. */ + attributes: Array> + /** Stock keeping unit. */ + sku?: Maybe + /** Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item. */ + trackInventory?: Maybe + /** Weight of the Product Variant. */ + weight?: Maybe + /** Product ID of which type is the variant. */ + product: Scalars['ID'] + /** Stocks of a product available for sale. */ + stocks?: Maybe> +} + +export type StockInput = { + /** Warehouse in which stock is located. */ + warehouse: Scalars['ID'] + /** Quantity of items available for sell. */ + quantity: Scalars['Int'] +} + +/** Deletes a product variant. */ +export type ProductVariantDelete = { + __typename?: 'ProductVariantDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + productErrors: Array + productVariant?: Maybe +} + +/** Creates product variants for a given product. */ +export type ProductVariantBulkCreate = { + __typename?: 'ProductVariantBulkCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were created. */ + count: Scalars['Int'] + /** List of the created variants. */ + productVariants: Array + bulkProductErrors: Array +} + +export type BulkProductError = { + __typename?: 'BulkProductError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: ProductErrorCode + /** List of attributes IDs which causes the error. */ + attributes?: Maybe> + /** List of attribute values IDs which causes the error. */ + values?: Maybe> + /** Index of an input list item that caused the error. */ + index?: Maybe + /** List of warehouse IDs which causes the error. */ + warehouses?: Maybe> + /** List of channel IDs which causes the error. */ + channels?: Maybe> +} + +export type ProductVariantBulkCreateInput = { + /** List of attributes specific to this variant. */ + attributes: Array> + /** Stock keeping unit. */ + sku: Scalars['String'] + /** Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item. */ + trackInventory?: Maybe + /** Weight of the Product Variant. */ + weight?: Maybe + /** Stocks of a product available for sale. */ + stocks?: Maybe> + /** List of prices assigned to channels. */ + channelListings?: Maybe> +} + +export type BulkAttributeValueInput = { + /** ID of the selected attribute. */ + id?: Maybe + /** The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created. */ + values: Array> +} + +export type ProductVariantChannelListingAddInput = { + /** ID of a channel. */ + channelId: Scalars['ID'] + /** Price of the particular variant in channel. */ + price: Scalars['PositiveDecimal'] + /** Cost price of the variant in channel. */ + costPrice?: Maybe +} + +/** Deletes product variants. */ +export type ProductVariantBulkDelete = { + __typename?: 'ProductVariantBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + productErrors: Array +} + +/** Creates stocks for product variant. */ +export type ProductVariantStocksCreate = { + __typename?: 'ProductVariantStocksCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Updated product variant. */ + productVariant?: Maybe + bulkStockErrors: Array +} + +export type BulkStockError = { + __typename?: 'BulkStockError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: ProductErrorCode + /** List of attributes IDs which causes the error. */ + attributes?: Maybe> + /** List of attribute values IDs which causes the error. */ + values?: Maybe> + /** Index of an input list item that caused the error. */ + index?: Maybe +} + +/** Delete stocks from product variant. */ +export type ProductVariantStocksDelete = { + __typename?: 'ProductVariantStocksDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Updated product variant. */ + productVariant?: Maybe + stockErrors: Array +} + +export type StockError = { + __typename?: 'StockError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: StockErrorCode +} + +/** An enumeration. */ +export enum StockErrorCode { + AlreadyExists = 'ALREADY_EXISTS', + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', + Unique = 'UNIQUE', +} + +/** Update stocks for product variant. */ +export type ProductVariantStocksUpdate = { + __typename?: 'ProductVariantStocksUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Updated product variant. */ + productVariant?: Maybe + bulkStockErrors: Array +} + +/** Updates an existing variant for product. */ +export type ProductVariantUpdate = { + __typename?: 'ProductVariantUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + productErrors: Array + productVariant?: Maybe +} + +export type ProductVariantInput = { + /** List of attributes specific to this variant. */ + attributes?: Maybe>> + /** Stock keeping unit. */ + sku?: Maybe + /** Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item. */ + trackInventory?: Maybe + /** Weight of the Product Variant. */ + weight?: Maybe +} + +/** Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook. */ +export type ProductVariantSetDefault = { + __typename?: 'ProductVariantSetDefault' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + product?: Maybe + productErrors: Array +} + +/** Creates/Updates translations for Product Variant. */ +export type ProductVariantTranslate = { + __typename?: 'ProductVariantTranslate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + translationErrors: Array + productVariant?: Maybe +} + +/** Manage product variant prices in channels. */ +export type ProductVariantChannelListingUpdate = { + __typename?: 'ProductVariantChannelListingUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated product variant instance. */ + variant?: Maybe + productChannelListingErrors: Array +} + +/** Reorder product variant attribute values. */ +export type ProductVariantReorderAttributeValues = { + __typename?: 'ProductVariantReorderAttributeValues' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Product variant from which attribute values are reordered. */ + productVariant?: Maybe + productErrors: Array +} + +/** Assign an media to a product variant. */ +export type VariantMediaAssign = { + __typename?: 'VariantMediaAssign' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + productVariant?: Maybe + media?: Maybe + productErrors: Array +} + +/** Unassign an media from a product variant. */ +export type VariantMediaUnassign = { + __typename?: 'VariantMediaUnassign' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + productVariant?: Maybe + media?: Maybe + productErrors: Array +} + +/** Captures the authorized payment amount. */ +export type PaymentCapture = { + __typename?: 'PaymentCapture' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Updated payment. */ + payment?: Maybe + paymentErrors: Array +} + +export type PaymentError = { + __typename?: 'PaymentError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: PaymentErrorCode +} + +/** An enumeration. */ +export enum PaymentErrorCode { + BillingAddressNotSet = 'BILLING_ADDRESS_NOT_SET', + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', + Unique = 'UNIQUE', + PartialPaymentNotAllowed = 'PARTIAL_PAYMENT_NOT_ALLOWED', + ShippingAddressNotSet = 'SHIPPING_ADDRESS_NOT_SET', + InvalidShippingMethod = 'INVALID_SHIPPING_METHOD', + ShippingMethodNotSet = 'SHIPPING_METHOD_NOT_SET', + PaymentError = 'PAYMENT_ERROR', + NotSupportedGateway = 'NOT_SUPPORTED_GATEWAY', +} + +/** Refunds the captured payment amount. */ +export type PaymentRefund = { + __typename?: 'PaymentRefund' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Updated payment. */ + payment?: Maybe + paymentErrors: Array +} + +/** Voids the authorized payment. */ +export type PaymentVoid = { + __typename?: 'PaymentVoid' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Updated payment. */ + payment?: Maybe + paymentErrors: Array +} + +/** Initializes payment process when it is required by gateway. */ +export type PaymentInitialize = { + __typename?: 'PaymentInitialize' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + initializedPayment?: Maybe + paymentErrors: Array +} + +/** Server-side data generated by a payment gateway. Optional step when the payment provider requires an additional action to initialize payment session. */ +export type PaymentInitialized = { + __typename?: 'PaymentInitialized' + /** ID of a payment gateway. */ + gateway: Scalars['String'] + /** Payment gateway name. */ + name: Scalars['String'] + /** Initialized data by gateway. */ + data?: Maybe +} + +/** Creates a new page. */ +export type PageCreate = { + __typename?: 'PageCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + pageErrors: Array + page?: Maybe +} + +export type PageError = { + __typename?: 'PageError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: PageErrorCode + /** List of attributes IDs which causes the error. */ + attributes?: Maybe> + /** List of attribute values IDs which causes the error. */ + values?: Maybe> +} + +/** An enumeration. */ +export enum PageErrorCode { + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', + Unique = 'UNIQUE', + DuplicatedInputItem = 'DUPLICATED_INPUT_ITEM', + AttributeAlreadyAssigned = 'ATTRIBUTE_ALREADY_ASSIGNED', +} + +export type PageCreateInput = { + /** Page internal name. */ + slug?: Maybe + /** Page title. */ + title?: Maybe + /** Page content in JSON format. */ + content?: Maybe + /** List of attributes. */ + attributes?: Maybe> + /** Determines if page is visible in the storefront. */ + isPublished?: Maybe + /** Publication date. ISO 8601 standard. */ + publicationDate?: Maybe + /** Search engine optimization fields. */ + seo?: Maybe + /** ID of the page type that page belongs to. */ + pageType: Scalars['ID'] +} + +/** Deletes a page. */ +export type PageDelete = { + __typename?: 'PageDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + pageErrors: Array + page?: Maybe +} + +/** Deletes pages. */ +export type PageBulkDelete = { + __typename?: 'PageBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + pageErrors: Array +} + +/** Publish pages. */ +export type PageBulkPublish = { + __typename?: 'PageBulkPublish' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + pageErrors: Array +} + +/** Updates an existing page. */ +export type PageUpdate = { + __typename?: 'PageUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + pageErrors: Array + page?: Maybe +} + +export type PageInput = { + /** Page internal name. */ + slug?: Maybe + /** Page title. */ + title?: Maybe + /** Page content in JSON format. */ + content?: Maybe + /** List of attributes. */ + attributes?: Maybe> + /** Determines if page is visible in the storefront. */ + isPublished?: Maybe + /** Publication date. ISO 8601 standard. */ + publicationDate?: Maybe + /** Search engine optimization fields. */ + seo?: Maybe +} + +/** Creates/Updates translations for Page. */ +export type PageTranslate = { + __typename?: 'PageTranslate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + translationErrors: Array + page?: Maybe +} + +export type PageTranslationInput = { + seoTitle?: Maybe + seoDescription?: Maybe + title?: Maybe + content?: Maybe +} + +/** Create a new page type. */ +export type PageTypeCreate = { + __typename?: 'PageTypeCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + pageErrors: Array + pageType?: Maybe +} + +export type PageTypeCreateInput = { + /** Name of the page type. */ + name?: Maybe + /** Page type slug. */ + slug?: Maybe + /** List of attribute IDs to be assigned to the page type. */ + addAttributes?: Maybe> +} + +/** Update page type. */ +export type PageTypeUpdate = { + __typename?: 'PageTypeUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + pageErrors: Array + pageType?: Maybe +} + +export type PageTypeUpdateInput = { + /** Name of the page type. */ + name?: Maybe + /** Page type slug. */ + slug?: Maybe + /** List of attribute IDs to be assigned to the page type. */ + addAttributes?: Maybe> + /** List of attribute IDs to be assigned to the page type. */ + removeAttributes?: Maybe> +} + +/** Delete a page type. */ +export type PageTypeDelete = { + __typename?: 'PageTypeDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + pageErrors: Array + pageType?: Maybe +} + +/** Delete page types. */ +export type PageTypeBulkDelete = { + __typename?: 'PageTypeBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + pageErrors: Array +} + +/** Assign attributes to a given page type. */ +export type PageAttributeAssign = { + __typename?: 'PageAttributeAssign' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** The updated page type. */ + pageType?: Maybe + pageErrors: Array +} + +/** Unassign attributes from a given page type. */ +export type PageAttributeUnassign = { + __typename?: 'PageAttributeUnassign' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** The updated page type. */ + pageType?: Maybe + pageErrors: Array +} + +/** Reorder the attributes of a page type. */ +export type PageTypeReorderAttributes = { + __typename?: 'PageTypeReorderAttributes' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Page type from which attributes are reordered. */ + pageType?: Maybe + pageErrors: Array +} + +/** Reorder page attribute values. */ +export type PageReorderAttributeValues = { + __typename?: 'PageReorderAttributeValues' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Page from which attribute values are reordered. */ + page?: Maybe + pageErrors: Array +} + +/** Completes creating an order. */ +export type DraftOrderComplete = { + __typename?: 'DraftOrderComplete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Completed order. */ + order?: Maybe + orderErrors: Array +} + +export type OrderError = { + __typename?: 'OrderError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: OrderErrorCode + /** Warehouse ID which causes the error. */ + warehouse?: Maybe + /** Order line ID which causes the error. */ + orderLine?: Maybe + /** List of product variants that are associated with the error */ + variants?: Maybe> +} + +/** An enumeration. */ +export enum OrderErrorCode { + BillingAddressNotSet = 'BILLING_ADDRESS_NOT_SET', + CannotCancelFulfillment = 'CANNOT_CANCEL_FULFILLMENT', + CannotCancelOrder = 'CANNOT_CANCEL_ORDER', + CannotDelete = 'CANNOT_DELETE', + CannotDiscount = 'CANNOT_DISCOUNT', + CannotRefund = 'CANNOT_REFUND', + CaptureInactivePayment = 'CAPTURE_INACTIVE_PAYMENT', + NotEditable = 'NOT_EDITABLE', + FulfillOrderLine = 'FULFILL_ORDER_LINE', + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + ProductNotPublished = 'PRODUCT_NOT_PUBLISHED', + ProductUnavailableForPurchase = 'PRODUCT_UNAVAILABLE_FOR_PURCHASE', + NotFound = 'NOT_FOUND', + OrderNoShippingAddress = 'ORDER_NO_SHIPPING_ADDRESS', + PaymentError = 'PAYMENT_ERROR', + PaymentMissing = 'PAYMENT_MISSING', + Required = 'REQUIRED', + ShippingMethodNotApplicable = 'SHIPPING_METHOD_NOT_APPLICABLE', + ShippingMethodRequired = 'SHIPPING_METHOD_REQUIRED', + TaxError = 'TAX_ERROR', + Unique = 'UNIQUE', + VoidInactivePayment = 'VOID_INACTIVE_PAYMENT', + ZeroQuantity = 'ZERO_QUANTITY', + InvalidQuantity = 'INVALID_QUANTITY', + InsufficientStock = 'INSUFFICIENT_STOCK', + DuplicatedInputItem = 'DUPLICATED_INPUT_ITEM', + NotAvailableInChannel = 'NOT_AVAILABLE_IN_CHANNEL', + ChannelInactive = 'CHANNEL_INACTIVE', +} + +/** Creates a new draft order. */ +export type DraftOrderCreate = { + __typename?: 'DraftOrderCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + orderErrors: Array + order?: Maybe +} + +export type DraftOrderCreateInput = { + /** Billing address of the customer. */ + billingAddress?: Maybe + user?: Maybe + /** Email address of the customer. */ + userEmail?: Maybe + /** Discount amount for the order. */ + discount?: Maybe + /** Shipping address of the customer. */ + shippingAddress?: Maybe + /** ID of a selected shipping method. */ + shippingMethod?: Maybe + /** ID of the voucher associated with the order. */ + voucher?: Maybe + /** A note from a customer. Visible by customers in the order summary. */ + customerNote?: Maybe + /** ID of the channel associated with the order. */ + channel?: Maybe + /** URL of a view where users should be redirected to see the order details. URL in RFC 1808 format. */ + redirectUrl?: Maybe + /** Variant line input consisting of variant ID and quantity of products. */ + lines?: Maybe>> +} + +export type OrderLineCreateInput = { + /** Number of variant items ordered. */ + quantity: Scalars['Int'] + /** Product variant ID. */ + variantId: Scalars['ID'] +} + +/** Deletes a draft order. */ +export type DraftOrderDelete = { + __typename?: 'DraftOrderDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + orderErrors: Array + order?: Maybe +} + +/** Deletes draft orders. */ +export type DraftOrderBulkDelete = { + __typename?: 'DraftOrderBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + orderErrors: Array +} + +/** Deletes order lines. */ +export type DraftOrderLinesBulkDelete = { + __typename?: 'DraftOrderLinesBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + orderErrors: Array +} + +/** Updates a draft order. */ +export type DraftOrderUpdate = { + __typename?: 'DraftOrderUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + orderErrors: Array + order?: Maybe +} + +export type DraftOrderInput = { + /** Billing address of the customer. */ + billingAddress?: Maybe + user?: Maybe + /** Email address of the customer. */ + userEmail?: Maybe + /** Discount amount for the order. */ + discount?: Maybe + /** Shipping address of the customer. */ + shippingAddress?: Maybe + /** ID of a selected shipping method. */ + shippingMethod?: Maybe + /** ID of the voucher associated with the order. */ + voucher?: Maybe + /** A note from a customer. Visible by customers in the order summary. */ + customerNote?: Maybe + /** ID of the channel associated with the order. */ + channel?: Maybe + /** URL of a view where users should be redirected to see the order details. URL in RFC 1808 format. */ + redirectUrl?: Maybe +} + +/** Adds note to the order. */ +export type OrderAddNote = { + __typename?: 'OrderAddNote' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Order with the note added. */ + order?: Maybe + /** Order note created. */ + event?: Maybe + orderErrors: Array +} + +export type OrderAddNoteInput = { + /** Note message. */ message: Scalars['String'] } -/** Represents a Shopify hosted video. */ -export type Video = Node & - Media & { - __typename?: 'Video' - /** A word or phrase to share the nature or contents of a media. */ - alt?: Maybe - /** Globally unique identifier. */ - id: Scalars['ID'] - /** The media content type. */ - mediaContentType: MediaContentType - /** The preview image for the media. */ - previewImage?: Maybe - /** The sources for a video. */ - sources: Array - } +/** Cancel an order. */ +export type OrderCancel = { + __typename?: 'OrderCancel' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Canceled order. */ + order?: Maybe + orderErrors: Array +} -/** Represents a source for a Shopify hosted video. */ -export type VideoSource = { - __typename?: 'VideoSource' - /** The format of the video source. */ - format: Scalars['String'] - /** The height of the video. */ - height: Scalars['Int'] - /** The video MIME type. */ - mimeType: Scalars['String'] - /** The URL of the video. */ +/** Capture an order. */ +export type OrderCapture = { + __typename?: 'OrderCapture' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Captured order. */ + order?: Maybe + orderErrors: Array +} + +/** Confirms an unconfirmed order by changing status to unfulfilled. */ +export type OrderConfirm = { + __typename?: 'OrderConfirm' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + order?: Maybe + orderErrors: Array +} + +/** Creates new fulfillments for an order. */ +export type OrderFulfill = { + __typename?: 'OrderFulfill' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** List of created fulfillments. */ + fulfillments?: Maybe>> + /** Fulfilled order. */ + order?: Maybe + orderErrors: Array +} + +export type OrderFulfillInput = { + /** List of items informing how to fulfill the order. */ + lines: Array + /** If true, send an email notification to the customer. */ + notifyCustomer?: Maybe +} + +export type OrderFulfillLineInput = { + /** The ID of the order line. */ + orderLineId?: Maybe + /** List of stock items to create. */ + stocks: Array +} + +export type OrderFulfillStockInput = { + /** The number of line items to be fulfilled from given warehouse. */ + quantity: Scalars['Int'] + /** ID of the warehouse from which the item will be fulfilled. */ + warehouse: Scalars['ID'] +} + +/** Cancels existing fulfillment and optionally restocks items. */ +export type FulfillmentCancel = { + __typename?: 'FulfillmentCancel' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A canceled fulfillment. */ + fulfillment?: Maybe + /** Order which fulfillment was cancelled. */ + order?: Maybe + orderErrors: Array +} + +export type FulfillmentCancelInput = { + /** ID of warehouse where items will be restock. */ + warehouseId: Scalars['ID'] +} + +/** Updates a fulfillment for an order. */ +export type FulfillmentUpdateTracking = { + __typename?: 'FulfillmentUpdateTracking' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A fulfillment with updated tracking. */ + fulfillment?: Maybe + /** Order for which fulfillment was updated. */ + order?: Maybe + orderErrors: Array +} + +export type FulfillmentUpdateTrackingInput = { + /** Fulfillment tracking number. */ + trackingNumber?: Maybe + /** If true, send an email notification to the customer. */ + notifyCustomer?: Maybe +} + +/** Refund products. */ +export type FulfillmentRefundProducts = { + __typename?: 'FulfillmentRefundProducts' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A refunded fulfillment. */ + fulfillment?: Maybe + /** Order which fulfillment was refunded. */ + order?: Maybe + orderErrors: Array +} + +export type OrderRefundProductsInput = { + /** List of unfulfilled lines to refund. */ + orderLines?: Maybe> + /** List of fulfilled lines to refund. */ + fulfillmentLines?: Maybe> + /** The total amount of refund when the value is provided manually. */ + amountToRefund?: Maybe + /** If true, Saleor will refund shipping costs. If amountToRefund is providedincludeShippingCosts will be ignored. */ + includeShippingCosts?: Maybe +} + +export type OrderRefundLineInput = { + /** The ID of the order line to refund. */ + orderLineId: Scalars['ID'] + /** The number of items to be refunded. */ + quantity: Scalars['Int'] +} + +export type OrderRefundFulfillmentLineInput = { + /** The ID of the fulfillment line to refund. */ + fulfillmentLineId: Scalars['ID'] + /** The number of items to be refunded. */ + quantity: Scalars['Int'] +} + +/** Return products. */ +export type FulfillmentReturnProducts = { + __typename?: 'FulfillmentReturnProducts' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A return fulfillment. */ + returnFulfillment?: Maybe + /** A replace fulfillment. */ + replaceFulfillment?: Maybe + /** Order which fulfillment was returned. */ + order?: Maybe + /** A draft order which was created for products with replace flag. */ + replaceOrder?: Maybe + orderErrors: Array +} + +export type OrderReturnProductsInput = { + /** List of unfulfilled lines to return. */ + orderLines?: Maybe> + /** List of fulfilled lines to return. */ + fulfillmentLines?: Maybe> + /** The total amount of refund when the value is provided manually. */ + amountToRefund?: Maybe + /** If true, Saleor will refund shipping costs. If amountToRefund is providedincludeShippingCosts will be ignored. */ + includeShippingCosts?: Maybe + /** If true, Saleor will call refund action for all lines. */ + refund?: Maybe +} + +export type OrderReturnLineInput = { + /** The ID of the order line to return. */ + orderLineId: Scalars['ID'] + /** The number of items to be returned. */ + quantity: Scalars['Int'] + /** Determines, if the line should be added to replace order. */ + replace?: Maybe +} + +export type OrderReturnFulfillmentLineInput = { + /** The ID of the fulfillment line to return. */ + fulfillmentLineId: Scalars['ID'] + /** The number of items to be returned. */ + quantity: Scalars['Int'] + /** Determines, if the line should be added to replace order. */ + replace?: Maybe +} + +/** Create order lines for an order. */ +export type OrderLinesCreate = { + __typename?: 'OrderLinesCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Related order. */ + order?: Maybe + /** List of added order lines. */ + orderLines?: Maybe> + orderErrors: Array +} + +/** Deletes an order line from an order. */ +export type OrderLineDelete = { + __typename?: 'OrderLineDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A related order. */ + order?: Maybe + /** An order line that was deleted. */ + orderLine?: Maybe + orderErrors: Array +} + +/** Updates an order line of an order. */ +export type OrderLineUpdate = { + __typename?: 'OrderLineUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Related order. */ + order?: Maybe + orderErrors: Array + orderLine?: Maybe +} + +export type OrderLineInput = { + /** Number of variant items ordered. */ + quantity: Scalars['Int'] +} + +/** Adds discount to the order. */ +export type OrderDiscountAdd = { + __typename?: 'OrderDiscountAdd' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Order which has been discounted. */ + order?: Maybe + orderErrors: Array +} + +export type OrderDiscountCommonInput = { + /** Type of the discount: fixed or percent */ + valueType: DiscountValueTypeEnum + /** Value of the discount. Can store fixed value or percent value */ + value: Scalars['PositiveDecimal'] + /** Explanation for the applied discount. */ + reason?: Maybe +} + +/** Update discount for the order. */ +export type OrderDiscountUpdate = { + __typename?: 'OrderDiscountUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Order which has been discounted. */ + order?: Maybe + orderErrors: Array +} + +/** Remove discount from the order. */ +export type OrderDiscountDelete = { + __typename?: 'OrderDiscountDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Order which has removed discount. */ + order?: Maybe + orderErrors: Array +} + +/** Update discount for the order line. */ +export type OrderLineDiscountUpdate = { + __typename?: 'OrderLineDiscountUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Order line which has been discounted. */ + orderLine?: Maybe + /** Order which is related to the discounted line. */ + order?: Maybe + orderErrors: Array +} + +/** Remove discount applied to the order line. */ +export type OrderLineDiscountRemove = { + __typename?: 'OrderLineDiscountRemove' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Order line which has removed discount. */ + orderLine?: Maybe + /** Order which is related to line which has removed discount. */ + order?: Maybe + orderErrors: Array +} + +/** Mark order as manually paid. */ +export type OrderMarkAsPaid = { + __typename?: 'OrderMarkAsPaid' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Order marked as paid. */ + order?: Maybe + orderErrors: Array +} + +/** Refund an order. */ +export type OrderRefund = { + __typename?: 'OrderRefund' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A refunded order. */ + order?: Maybe + orderErrors: Array +} + +/** Updates an order. */ +export type OrderUpdate = { + __typename?: 'OrderUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + orderErrors: Array + order?: Maybe +} + +export type OrderUpdateInput = { + /** Billing address of the customer. */ + billingAddress?: Maybe + /** Email address of the customer. */ + userEmail?: Maybe + /** Shipping address of the customer. */ + shippingAddress?: Maybe +} + +/** Updates a shipping method of the order. */ +export type OrderUpdateShipping = { + __typename?: 'OrderUpdateShipping' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Order with updated shipping method. */ + order?: Maybe + orderErrors: Array +} + +export type OrderUpdateShippingInput = { + /** ID of the selected shipping method. */ + shippingMethod?: Maybe +} + +/** Void an order. */ +export type OrderVoid = { + __typename?: 'OrderVoid' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A voided order. */ + order?: Maybe + orderErrors: Array +} + +/** Cancels orders. */ +export type OrderBulkCancel = { + __typename?: 'OrderBulkCancel' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + orderErrors: Array +} + +/** Delete metadata of an object. */ +export type DeleteMetadata = { + __typename?: 'DeleteMetadata' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + metadataErrors: Array + item?: Maybe +} + +export type MetadataError = { + __typename?: 'MetadataError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: MetadataErrorCode +} + +/** An enumeration. */ +export enum MetadataErrorCode { + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', +} + +/** Delete object's private metadata. */ +export type DeletePrivateMetadata = { + __typename?: 'DeletePrivateMetadata' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + metadataErrors: Array + item?: Maybe +} + +/** Updates metadata of an object. */ +export type UpdateMetadata = { + __typename?: 'UpdateMetadata' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + metadataErrors: Array + item?: Maybe +} + +/** Updates private metadata of an object. */ +export type UpdatePrivateMetadata = { + __typename?: 'UpdatePrivateMetadata' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + metadataErrors: Array + item?: Maybe +} + +/** Assigns storefront's navigation menus. */ +export type AssignNavigation = { + __typename?: 'AssignNavigation' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Assigned navigation menu. */ + menu?: Maybe + menuErrors: Array +} + +export type MenuError = { + __typename?: 'MenuError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: MenuErrorCode +} + +/** An enumeration. */ +export enum MenuErrorCode { + CannotAssignNode = 'CANNOT_ASSIGN_NODE', + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + InvalidMenuItem = 'INVALID_MENU_ITEM', + NoMenuItemProvided = 'NO_MENU_ITEM_PROVIDED', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', + TooManyMenuItems = 'TOO_MANY_MENU_ITEMS', + Unique = 'UNIQUE', +} + +export enum NavigationType { + /** Main storefront navigation. */ + Main = 'MAIN', + /** Secondary storefront navigation. */ + Secondary = 'SECONDARY', +} + +/** Creates a new Menu. */ +export type MenuCreate = { + __typename?: 'MenuCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + menuErrors: Array + menu?: Maybe +} + +export type MenuCreateInput = { + /** Name of the menu. */ + name: Scalars['String'] + /** Slug of the menu. Will be generated if not provided. */ + slug?: Maybe + /** List of menu items. */ + items?: Maybe>> +} + +export type MenuItemInput = { + /** Name of the menu item. */ + name?: Maybe + /** URL of the pointed item. */ + url?: Maybe + /** Category to which item points. */ + category?: Maybe + /** Collection to which item points. */ + collection?: Maybe + /** Page to which item points. */ + page?: Maybe +} + +/** Deletes a menu. */ +export type MenuDelete = { + __typename?: 'MenuDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + menuErrors: Array + menu?: Maybe +} + +/** Deletes menus. */ +export type MenuBulkDelete = { + __typename?: 'MenuBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + menuErrors: Array +} + +/** Updates a menu. */ +export type MenuUpdate = { + __typename?: 'MenuUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + menuErrors: Array + menu?: Maybe +} + +export type MenuInput = { + /** Name of the menu. */ + name?: Maybe + /** Slug of the menu. */ + slug?: Maybe +} + +/** Creates a new menu item. */ +export type MenuItemCreate = { + __typename?: 'MenuItemCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + menuErrors: Array + menuItem?: Maybe +} + +export type MenuItemCreateInput = { + /** Name of the menu item. */ + name: Scalars['String'] + /** URL of the pointed item. */ + url?: Maybe + /** Category to which item points. */ + category?: Maybe + /** Collection to which item points. */ + collection?: Maybe + /** Page to which item points. */ + page?: Maybe + /** Menu to which item belongs. */ + menu: Scalars['ID'] + /** ID of the parent menu. If empty, menu will be top level menu. */ + parent?: Maybe +} + +/** Deletes a menu item. */ +export type MenuItemDelete = { + __typename?: 'MenuItemDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + menuErrors: Array + menuItem?: Maybe +} + +/** Deletes menu items. */ +export type MenuItemBulkDelete = { + __typename?: 'MenuItemBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + menuErrors: Array +} + +/** Updates a menu item. */ +export type MenuItemUpdate = { + __typename?: 'MenuItemUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + menuErrors: Array + menuItem?: Maybe +} + +/** Creates/Updates translations for Menu Item. */ +export type MenuItemTranslate = { + __typename?: 'MenuItemTranslate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + translationErrors: Array + menuItem?: Maybe +} + +/** Moves items of menus. */ +export type MenuItemMove = { + __typename?: 'MenuItemMove' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Assigned menu to move within. */ + menu?: Maybe + menuErrors: Array +} + +export type MenuItemMoveInput = { + /** The menu item ID to move. */ + itemId: Scalars['ID'] + /** ID of the parent menu. If empty, menu will be top level menu. */ + parentId?: Maybe + /** The new relative sorting position of the item (from -inf to +inf). 1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged. */ + sortOrder?: Maybe +} + +/** Request an invoice for the order using plugin. */ +export type InvoiceRequest = { + __typename?: 'InvoiceRequest' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Order related to an invoice. */ + order?: Maybe + invoiceErrors: Array + invoice?: Maybe +} + +export type InvoiceError = { + __typename?: 'InvoiceError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: InvoiceErrorCode +} + +/** An enumeration. */ +export enum InvoiceErrorCode { + Required = 'REQUIRED', + NotReady = 'NOT_READY', + UrlNotSet = 'URL_NOT_SET', + EmailNotSet = 'EMAIL_NOT_SET', + NumberNotSet = 'NUMBER_NOT_SET', + NotFound = 'NOT_FOUND', + InvalidStatus = 'INVALID_STATUS', +} + +/** Requests deletion of an invoice. */ +export type InvoiceRequestDelete = { + __typename?: 'InvoiceRequestDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + invoiceErrors: Array + invoice?: Maybe +} + +/** Creates a ready to send invoice. */ +export type InvoiceCreate = { + __typename?: 'InvoiceCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + invoiceErrors: Array + invoice?: Maybe +} + +export type InvoiceCreateInput = { + /** Invoice number. */ + number: Scalars['String'] + /** URL of an invoice to download. */ url: Scalars['String'] - /** The width of the video. */ - width: Scalars['Int'] } -/** Units of measurement for weight. */ -export enum WeightUnit { - /** 1 kilogram equals 1000 grams. */ - Kilograms = 'KILOGRAMS', - /** Metric system unit of mass. */ - Grams = 'GRAMS', - /** 1 pound equals 16 ounces. */ - Pounds = 'POUNDS', - /** Imperial system unit of mass. */ - Ounces = 'OUNCES', +/** Deletes an invoice. */ +export type InvoiceDelete = { + __typename?: 'InvoiceDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + invoiceErrors: Array + invoice?: Maybe } -export type Unnamed_1_QueryVariables = Exact<{ - first: Scalars['Int'] +/** Updates an invoice. */ +export type InvoiceUpdate = { + __typename?: 'InvoiceUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + invoiceErrors: Array + invoice?: Maybe +} + +export type UpdateInvoiceInput = { + /** Invoice number */ + number?: Maybe + /** URL of an invoice to download. */ + url?: Maybe +} + +/** Send an invoice notification to the customer. */ +export type InvoiceSendNotification = { + __typename?: 'InvoiceSendNotification' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + invoiceErrors: Array + invoice?: Maybe +} + +/** Activate a gift card. */ +export type GiftCardActivate = { + __typename?: 'GiftCardActivate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A gift card to activate. */ + giftCard?: Maybe + giftCardErrors: Array +} + +export type GiftCardError = { + __typename?: 'GiftCardError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: GiftCardErrorCode +} + +/** An enumeration. */ +export enum GiftCardErrorCode { + AlreadyExists = 'ALREADY_EXISTS', + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', + Unique = 'UNIQUE', +} + +/** Creates a new gift card. */ +export type GiftCardCreate = { + __typename?: 'GiftCardCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + giftCardErrors: Array + giftCard?: Maybe +} + +export type GiftCardCreateInput = { + /** Start date of the gift card in ISO 8601 format. */ + startDate?: Maybe + /** End date of the gift card in ISO 8601 format. */ + endDate?: Maybe + /** Value of the gift card. */ + balance?: Maybe + /** The customer's email of the gift card buyer. */ + userEmail?: Maybe + /** Code to use the gift card. */ + code?: Maybe +} + +/** Deactivate a gift card. */ +export type GiftCardDeactivate = { + __typename?: 'GiftCardDeactivate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A gift card to deactivate. */ + giftCard?: Maybe + giftCardErrors: Array +} + +/** Update a gift card. */ +export type GiftCardUpdate = { + __typename?: 'GiftCardUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + giftCardErrors: Array + giftCard?: Maybe +} + +export type GiftCardUpdateInput = { + /** Start date of the gift card in ISO 8601 format. */ + startDate?: Maybe + /** End date of the gift card in ISO 8601 format. */ + endDate?: Maybe + /** Value of the gift card. */ + balance?: Maybe + /** The customer's email of the gift card buyer. */ + userEmail?: Maybe +} + +/** Update plugin configuration. */ +export type PluginUpdate = { + __typename?: 'PluginUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + plugin?: Maybe + pluginsErrors: Array +} + +export type PluginError = { + __typename?: 'PluginError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: PluginErrorCode +} + +/** An enumeration. */ +export enum PluginErrorCode { + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + PluginMisconfigured = 'PLUGIN_MISCONFIGURED', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', + Unique = 'UNIQUE', +} + +export type PluginUpdateInput = { + /** Indicates whether the plugin should be enabled. */ + active?: Maybe + /** Configuration of the plugin. */ + configuration?: Maybe>> +} + +export type ConfigurationItemInput = { + /** Name of the field to update. */ + name: Scalars['String'] + /** Value of the given field to update. */ + value?: Maybe +} + +/** Creates a new sale. */ +export type SaleCreate = { + __typename?: 'SaleCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + discountErrors: Array + sale?: Maybe +} + +export type DiscountError = { + __typename?: 'DiscountError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** List of products IDs which causes the error. */ + products?: Maybe> + /** The error code. */ + code: DiscountErrorCode + /** List of channels IDs which causes the error. */ + channels?: Maybe> +} + +/** An enumeration. */ +export enum DiscountErrorCode { + AlreadyExists = 'ALREADY_EXISTS', + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', + Unique = 'UNIQUE', + CannotManageProductWithoutVariant = 'CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT', + DuplicatedInputItem = 'DUPLICATED_INPUT_ITEM', +} + +export type SaleInput = { + /** Voucher name. */ + name?: Maybe + /** Fixed or percentage. */ + type?: Maybe + /** Value of the voucher. */ + value?: Maybe + /** Products related to the discount. */ + products?: Maybe>> + /** Categories related to the discount. */ + categories?: Maybe>> + /** Collections related to the discount. */ + collections?: Maybe>> + /** Start date of the voucher in ISO 8601 format. */ + startDate?: Maybe + /** End date of the voucher in ISO 8601 format. */ + endDate?: Maybe +} + +/** Deletes a sale. */ +export type SaleDelete = { + __typename?: 'SaleDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + discountErrors: Array + sale?: Maybe +} + +/** Deletes sales. */ +export type SaleBulkDelete = { + __typename?: 'SaleBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + discountErrors: Array +} + +/** Updates a sale. */ +export type SaleUpdate = { + __typename?: 'SaleUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + discountErrors: Array + sale?: Maybe +} + +/** Adds products, categories, collections to a voucher. */ +export type SaleAddCatalogues = { + __typename?: 'SaleAddCatalogues' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Sale of which catalogue IDs will be modified. */ + sale?: Maybe + discountErrors: Array +} + +export type CatalogueInput = { + /** Products related to the discount. */ + products?: Maybe>> + /** Categories related to the discount. */ + categories?: Maybe>> + /** Collections related to the discount. */ + collections?: Maybe>> +} + +/** Removes products, categories, collections from a sale. */ +export type SaleRemoveCatalogues = { + __typename?: 'SaleRemoveCatalogues' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Sale of which catalogue IDs will be modified. */ + sale?: Maybe + discountErrors: Array +} + +/** Creates/updates translations for a sale. */ +export type SaleTranslate = { + __typename?: 'SaleTranslate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + translationErrors: Array + sale?: Maybe +} + +/** Manage sale's availability in channels. */ +export type SaleChannelListingUpdate = { + __typename?: 'SaleChannelListingUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated sale instance. */ + sale?: Maybe + discountErrors: Array +} + +export type SaleChannelListingInput = { + /** List of channels to which the sale should be assigned. */ + addChannels?: Maybe> + /** List of channels from which the sale should be unassigned. */ + removeChannels?: Maybe> +} + +export type SaleChannelListingAddInput = { + /** ID of a channel. */ + channelId: Scalars['ID'] + /** The value of the discount. */ + discountValue: Scalars['PositiveDecimal'] +} + +/** Creates a new voucher. */ +export type VoucherCreate = { + __typename?: 'VoucherCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + discountErrors: Array + voucher?: Maybe +} + +export type VoucherInput = { + /** Voucher type: PRODUCT, CATEGORY SHIPPING or ENTIRE_ORDER. */ + type?: Maybe + /** Voucher name. */ + name?: Maybe + /** Code to use the voucher. */ + code?: Maybe + /** Start date of the voucher in ISO 8601 format. */ + startDate?: Maybe + /** End date of the voucher in ISO 8601 format. */ + endDate?: Maybe + /** Choices: fixed or percentage. */ + discountValueType?: Maybe + /** Products discounted by the voucher. */ + products?: Maybe>> + /** Collections discounted by the voucher. */ + collections?: Maybe>> + /** Categories discounted by the voucher. */ + categories?: Maybe>> + /** Minimal quantity of checkout items required to apply the voucher. */ + minCheckoutItemsQuantity?: Maybe + /** Country codes that can be used with the shipping voucher. */ + countries?: Maybe>> + /** Voucher should be applied to the cheapest item or entire order. */ + applyOncePerOrder?: Maybe + /** Voucher should be applied once per customer. */ + applyOncePerCustomer?: Maybe + /** Limit number of times this voucher can be used in total. */ + usageLimit?: Maybe +} + +/** Deletes a voucher. */ +export type VoucherDelete = { + __typename?: 'VoucherDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + discountErrors: Array + voucher?: Maybe +} + +/** Deletes vouchers. */ +export type VoucherBulkDelete = { + __typename?: 'VoucherBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + discountErrors: Array +} + +/** Updates a voucher. */ +export type VoucherUpdate = { + __typename?: 'VoucherUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + discountErrors: Array + voucher?: Maybe +} + +/** Adds products, categories, collections to a voucher. */ +export type VoucherAddCatalogues = { + __typename?: 'VoucherAddCatalogues' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Voucher of which catalogue IDs will be modified. */ + voucher?: Maybe + discountErrors: Array +} + +/** Removes products, categories, collections from a voucher. */ +export type VoucherRemoveCatalogues = { + __typename?: 'VoucherRemoveCatalogues' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Voucher of which catalogue IDs will be modified. */ + voucher?: Maybe + discountErrors: Array +} + +/** Creates/Updates translations for Voucher. */ +export type VoucherTranslate = { + __typename?: 'VoucherTranslate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + translationErrors: Array + voucher?: Maybe +} + +/** Manage voucher's availability in channels. */ +export type VoucherChannelListingUpdate = { + __typename?: 'VoucherChannelListingUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated voucher instance. */ + voucher?: Maybe + discountErrors: Array +} + +export type VoucherChannelListingInput = { + /** List of channels to which the voucher should be assigned. */ + addChannels?: Maybe> + /** List of channels from which the voucher should be unassigned. */ + removeChannels?: Maybe> +} + +export type VoucherChannelListingAddInput = { + /** ID of a channel. */ + channelId: Scalars['ID'] + /** Value of the voucher. */ + discountValue?: Maybe + /** Min purchase amount required to apply the voucher. */ + minAmountSpent?: Maybe +} + +/** Export products to csv file. */ +export type ExportProducts = { + __typename?: 'ExportProducts' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** The newly created export file job which is responsible for export data. */ + exportFile?: Maybe + exportErrors: Array +} + +export type ExportError = { + __typename?: 'ExportError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: ExportErrorCode +} + +/** An enumeration. */ +export enum ExportErrorCode { + Invalid = 'INVALID', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', +} + +export type ExportProductsInput = { + /** Determine which products should be exported. */ + scope: ExportScope + /** Filtering options for products. */ + filter?: Maybe + /** List of products IDS to export. */ + ids?: Maybe> + /** Input with info about fields which should be exported. */ + exportInfo?: Maybe + /** Type of exported file. */ + fileType: FileTypesEnum +} + +export enum ExportScope { + /** Export all products. */ + All = 'ALL', + /** Export products with given ids. */ + Ids = 'IDS', + /** Export the filtered products. */ + Filter = 'FILTER', +} + +export type ExportInfoInput = { + /** List of attribute ids witch should be exported. */ + attributes?: Maybe> + /** List of warehouse ids witch should be exported. */ + warehouses?: Maybe> + /** List of channels ids which should be exported. */ + channels?: Maybe> + /** List of product fields witch should be exported. */ + fields?: Maybe> +} + +export enum ProductFieldEnum { + Name = 'NAME', + Description = 'DESCRIPTION', + ProductType = 'PRODUCT_TYPE', + Category = 'CATEGORY', + Visible = 'VISIBLE', + ProductWeight = 'PRODUCT_WEIGHT', + Collections = 'COLLECTIONS', + ChargeTaxes = 'CHARGE_TAXES', + ProductMedia = 'PRODUCT_MEDIA', + VariantSku = 'VARIANT_SKU', + VariantWeight = 'VARIANT_WEIGHT', + VariantMedia = 'VARIANT_MEDIA', +} + +/** An enumeration. */ +export enum FileTypesEnum { + Csv = 'CSV', + Xlsx = 'XLSX', +} + +/** Upload a file. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec */ +export type FileUpload = { + __typename?: 'FileUpload' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + uploadedFile?: Maybe + uploadErrors: Array +} + +export type UploadError = { + __typename?: 'UploadError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: UploadErrorCode +} + +/** An enumeration. */ +export enum UploadErrorCode { + GraphqlError = 'GRAPHQL_ERROR', +} + +/** Adds a gift card or a voucher to a checkout. */ +export type CheckoutAddPromoCode = { + __typename?: 'CheckoutAddPromoCode' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** The checkout with the added gift card or voucher. */ + checkout?: Maybe + checkoutErrors: Array +} + +export type CheckoutError = { + __typename?: 'CheckoutError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: CheckoutErrorCode + /** List of varint IDs which causes the error. */ + variants?: Maybe> +} + +/** An enumeration. */ +export enum CheckoutErrorCode { + BillingAddressNotSet = 'BILLING_ADDRESS_NOT_SET', + CheckoutNotFullyPaid = 'CHECKOUT_NOT_FULLY_PAID', + GraphqlError = 'GRAPHQL_ERROR', + ProductNotPublished = 'PRODUCT_NOT_PUBLISHED', + ProductUnavailableForPurchase = 'PRODUCT_UNAVAILABLE_FOR_PURCHASE', + InsufficientStock = 'INSUFFICIENT_STOCK', + Invalid = 'INVALID', + InvalidShippingMethod = 'INVALID_SHIPPING_METHOD', + NotFound = 'NOT_FOUND', + PaymentError = 'PAYMENT_ERROR', + QuantityGreaterThanLimit = 'QUANTITY_GREATER_THAN_LIMIT', + Required = 'REQUIRED', + ShippingAddressNotSet = 'SHIPPING_ADDRESS_NOT_SET', + ShippingMethodNotApplicable = 'SHIPPING_METHOD_NOT_APPLICABLE', + ShippingMethodNotSet = 'SHIPPING_METHOD_NOT_SET', + ShippingNotRequired = 'SHIPPING_NOT_REQUIRED', + TaxError = 'TAX_ERROR', + Unique = 'UNIQUE', + VoucherNotApplicable = 'VOUCHER_NOT_APPLICABLE', + ZeroQuantity = 'ZERO_QUANTITY', + MissingChannelSlug = 'MISSING_CHANNEL_SLUG', + ChannelInactive = 'CHANNEL_INACTIVE', + UnavailableVariantInChannel = 'UNAVAILABLE_VARIANT_IN_CHANNEL', +} + +/** Update billing address in the existing checkout. */ +export type CheckoutBillingAddressUpdate = { + __typename?: 'CheckoutBillingAddressUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated checkout. */ + checkout?: Maybe + checkoutErrors: Array +} + +/** Completes the checkout. As a result a new order is created and a payment charge is made. This action requires a successful payment before it can be performed. In case additional confirmation step as 3D secure is required confirmationNeeded flag will be set to True and no order created until payment is confirmed with second call of this mutation. */ +export type CheckoutComplete = { + __typename?: 'CheckoutComplete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Placed order. */ + order?: Maybe + /** Set to true if payment needs to be confirmed before checkout is complete. */ + confirmationNeeded: Scalars['Boolean'] + /** Confirmation data used to process additional authorization steps. */ + confirmationData?: Maybe + checkoutErrors: Array +} + +/** Create a new checkout. */ +export type CheckoutCreate = { + __typename?: 'CheckoutCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Whether the checkout was created or the current active one was returned. Refer to checkoutLinesAdd and checkoutLinesUpdate to merge a cart with an active checkout. */ + created?: Maybe + checkoutErrors: Array + checkout?: Maybe +} + +export type CheckoutCreateInput = { + /** Slug of a channel in which to create a checkout. */ + channel?: Maybe + /** A list of checkout lines, each containing information about an item in the checkout. */ + lines: Array> + /** The customer's email address. */ + email?: Maybe + /** The mailing address to where the checkout will be shipped. Note: the address will be ignored if the checkout doesn't contain shippable items. */ + shippingAddress?: Maybe + /** Billing address of the customer. */ + billingAddress?: Maybe + /** Checkout language code. */ + languageCode?: Maybe +} + +export type CheckoutLineInput = { + /** The number of items purchased. */ + quantity: Scalars['Int'] + /** ID of the product variant. */ + variantId: Scalars['ID'] +} + +/** Sets the customer as the owner of the checkout. */ +export type CheckoutCustomerAttach = { + __typename?: 'CheckoutCustomerAttach' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated checkout. */ + checkout?: Maybe + checkoutErrors: Array +} + +/** Removes the user assigned as the owner of the checkout. */ +export type CheckoutCustomerDetach = { + __typename?: 'CheckoutCustomerDetach' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated checkout. */ + checkout?: Maybe + checkoutErrors: Array +} + +/** Updates email address in the existing checkout object. */ +export type CheckoutEmailUpdate = { + __typename?: 'CheckoutEmailUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated checkout. */ + checkout?: Maybe + checkoutErrors: Array +} + +/** Deletes a CheckoutLine. */ +export type CheckoutLineDelete = { + __typename?: 'CheckoutLineDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated checkout. */ + checkout?: Maybe + checkoutErrors: Array +} + +/** Adds a checkout line to the existing checkout. */ +export type CheckoutLinesAdd = { + __typename?: 'CheckoutLinesAdd' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated checkout. */ + checkout?: Maybe + checkoutErrors: Array +} + +/** Updates checkout line in the existing checkout. */ +export type CheckoutLinesUpdate = { + __typename?: 'CheckoutLinesUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated checkout. */ + checkout?: Maybe + checkoutErrors: Array +} + +/** Remove a gift card or a voucher from a checkout. */ +export type CheckoutRemovePromoCode = { + __typename?: 'CheckoutRemovePromoCode' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** The checkout with the removed gift card or voucher. */ + checkout?: Maybe + checkoutErrors: Array +} + +/** Create a new payment for given checkout. */ +export type CheckoutPaymentCreate = { + __typename?: 'CheckoutPaymentCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Related checkout object. */ + checkout?: Maybe + /** A newly created payment. */ + payment?: Maybe + paymentErrors: Array +} + +export type PaymentInput = { + /** A gateway to use with that payment. */ + gateway: Scalars['String'] + /** Client-side generated payment token, representing customer's billing data in a secure manner. */ + token?: Maybe + /** Total amount of the transaction, including all taxes and discounts. If no amount is provided, the checkout total will be used. */ + amount?: Maybe + /** URL of a storefront view where user should be redirected after requiring additional actions. Payment with additional actions will not be finished if this field is not provided. */ + returnUrl?: Maybe +} + +/** Update shipping address in the existing checkout. */ +export type CheckoutShippingAddressUpdate = { + __typename?: 'CheckoutShippingAddressUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated checkout. */ + checkout?: Maybe + checkoutErrors: Array +} + +/** Updates the shipping address of the checkout. */ +export type CheckoutShippingMethodUpdate = { + __typename?: 'CheckoutShippingMethodUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated checkout. */ + checkout?: Maybe + checkoutErrors: Array +} + +/** Update language code in the existing checkout. */ +export type CheckoutLanguageCodeUpdate = { + __typename?: 'CheckoutLanguageCodeUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated checkout. */ + checkout?: Maybe + checkoutErrors: Array +} + +/** Creates new channel. */ +export type ChannelCreate = { + __typename?: 'ChannelCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + channelErrors: Array + channel?: Maybe +} + +export type ChannelError = { + __typename?: 'ChannelError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: ChannelErrorCode + /** List of shipping zone IDs which causes the error. */ + shippingZones?: Maybe> +} + +/** An enumeration. */ +export enum ChannelErrorCode { + AlreadyExists = 'ALREADY_EXISTS', + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', + Unique = 'UNIQUE', + ChannelTargetIdMustBeDifferent = 'CHANNEL_TARGET_ID_MUST_BE_DIFFERENT', + ChannelsCurrencyMustBeTheSame = 'CHANNELS_CURRENCY_MUST_BE_THE_SAME', + ChannelWithOrders = 'CHANNEL_WITH_ORDERS', + DuplicatedInputItem = 'DUPLICATED_INPUT_ITEM', +} + +export type ChannelCreateInput = { + /** isActive flag. */ + isActive?: Maybe + /** Name of the channel. */ + name: Scalars['String'] + /** Slug of the channel. */ + slug: Scalars['String'] + /** Currency of the channel. */ + currencyCode: Scalars['String'] + /** List of shipping zones to assign to the channel. */ + addShippingZones?: Maybe> +} + +/** Update a channel. */ +export type ChannelUpdate = { + __typename?: 'ChannelUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + channelErrors: Array + channel?: Maybe +} + +export type ChannelUpdateInput = { + /** isActive flag. */ + isActive?: Maybe + /** Name of the channel. */ + name?: Maybe + /** Slug of the channel. */ + slug?: Maybe + /** List of shipping zones to assign to the channel. */ + addShippingZones?: Maybe> + /** List of shipping zones to unassign from the channel. */ + removeShippingZones?: Maybe> +} + +/** Delete a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. */ +export type ChannelDelete = { + __typename?: 'ChannelDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + channelErrors: Array + channel?: Maybe +} + +export type ChannelDeleteInput = { + /** ID of channel to migrate orders from origin channel. */ + targetChannel: Scalars['ID'] +} + +/** Activate a channel. */ +export type ChannelActivate = { + __typename?: 'ChannelActivate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Activated channel. */ + channel?: Maybe + channelErrors: Array +} + +/** Deactivate a channel. */ +export type ChannelDeactivate = { + __typename?: 'ChannelDeactivate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Deactivated channel. */ + channel?: Maybe + channelErrors: Array +} + +/** Creates an attribute. */ +export type AttributeCreate = { + __typename?: 'AttributeCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + attribute?: Maybe + attributeErrors: Array +} + +export type AttributeError = { + __typename?: 'AttributeError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: AttributeErrorCode +} + +/** An enumeration. */ +export enum AttributeErrorCode { + AlreadyExists = 'ALREADY_EXISTS', + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', + Unique = 'UNIQUE', +} + +export type AttributeCreateInput = { + /** The input type to use for entering attribute values in the dashboard. */ + inputType?: Maybe + /** The entity type which can be used as a reference. */ + entityType?: Maybe + /** Name of an attribute displayed in the interface. */ + name: Scalars['String'] + /** Internal representation of an attribute name. */ + slug?: Maybe + /** The attribute type. */ + type: AttributeTypeEnum + /** List of attribute's values. */ + values?: Maybe>> + /** Whether the attribute requires values to be passed or not. */ + valueRequired?: Maybe + /** Whether the attribute is for variants only. */ + isVariantOnly?: Maybe + /** Whether the attribute should be visible or not in storefront. */ + visibleInStorefront?: Maybe + /** Whether the attribute can be filtered in storefront. */ + filterableInStorefront?: Maybe + /** Whether the attribute can be filtered in dashboard. */ + filterableInDashboard?: Maybe + /** The position of the attribute in the storefront navigation (0 by default). */ + storefrontSearchPosition?: Maybe + /** Whether the attribute can be displayed in the admin product list. */ + availableInGrid?: Maybe +} + +export type AttributeValueCreateInput = { + /** Name of a value displayed in the interface. */ + name: Scalars['String'] + /** Represents the value of the attribute value. */ + value?: Maybe + /** Represents the text (JSON) of the attribute value. */ + richText?: Maybe +} + +/** Deletes an attribute. */ +export type AttributeDelete = { + __typename?: 'AttributeDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + attributeErrors: Array + attribute?: Maybe +} + +/** Updates attribute. */ +export type AttributeUpdate = { + __typename?: 'AttributeUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + attribute?: Maybe + attributeErrors: Array +} + +export type AttributeUpdateInput = { + /** Name of an attribute displayed in the interface. */ + name?: Maybe + /** Internal representation of an attribute name. */ + slug?: Maybe + /** IDs of values to be removed from this attribute. */ + removeValues?: Maybe>> + /** New values to be created for this attribute. */ + addValues?: Maybe>> + /** Whether the attribute requires values to be passed or not. */ + valueRequired?: Maybe + /** Whether the attribute is for variants only. */ + isVariantOnly?: Maybe + /** Whether the attribute should be visible or not in storefront. */ + visibleInStorefront?: Maybe + /** Whether the attribute can be filtered in storefront. */ + filterableInStorefront?: Maybe + /** Whether the attribute can be filtered in dashboard. */ + filterableInDashboard?: Maybe + /** The position of the attribute in the storefront navigation (0 by default). */ + storefrontSearchPosition?: Maybe + /** Whether the attribute can be displayed in the admin product list. */ + availableInGrid?: Maybe +} + +/** Creates/Updates translations for attribute. */ +export type AttributeTranslate = { + __typename?: 'AttributeTranslate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + translationErrors: Array + attribute?: Maybe +} + +/** Deletes attributes. */ +export type AttributeBulkDelete = { + __typename?: 'AttributeBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + attributeErrors: Array +} + +/** Deletes values of attributes. */ +export type AttributeValueBulkDelete = { + __typename?: 'AttributeValueBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + attributeErrors: Array +} + +/** Creates a value for an attribute. */ +export type AttributeValueCreate = { + __typename?: 'AttributeValueCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** The updated attribute. */ + attribute?: Maybe + attributeErrors: Array + attributeValue?: Maybe +} + +/** Deletes a value of an attribute. */ +export type AttributeValueDelete = { + __typename?: 'AttributeValueDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** The updated attribute. */ + attribute?: Maybe + attributeErrors: Array + attributeValue?: Maybe +} + +/** Updates value of an attribute. */ +export type AttributeValueUpdate = { + __typename?: 'AttributeValueUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** The updated attribute. */ + attribute?: Maybe + attributeErrors: Array + attributeValue?: Maybe +} + +/** Creates/Updates translations for attribute value. */ +export type AttributeValueTranslate = { + __typename?: 'AttributeValueTranslate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + translationErrors: Array + attributeValue?: Maybe +} + +export type AttributeValueTranslationInput = { + name?: Maybe + richText?: Maybe +} + +/** Reorder the values of an attribute. */ +export type AttributeReorderValues = { + __typename?: 'AttributeReorderValues' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Attribute from which values are reordered. */ + attribute?: Maybe + attributeErrors: Array +} + +/** Creates a new app. */ +export type AppCreate = { + __typename?: 'AppCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** The newly created authentication token. */ + authToken?: Maybe + appErrors: Array + app?: Maybe +} + +export type AppError = { + __typename?: 'AppError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: AppErrorCode + /** List of permissions which causes the error. */ + permissions?: Maybe> +} + +/** An enumeration. */ +export enum AppErrorCode { + Forbidden = 'FORBIDDEN', + GraphqlError = 'GRAPHQL_ERROR', + Invalid = 'INVALID', + InvalidStatus = 'INVALID_STATUS', + InvalidPermission = 'INVALID_PERMISSION', + InvalidUrlFormat = 'INVALID_URL_FORMAT', + InvalidManifestFormat = 'INVALID_MANIFEST_FORMAT', + ManifestUrlCantConnect = 'MANIFEST_URL_CANT_CONNECT', + NotFound = 'NOT_FOUND', + Required = 'REQUIRED', + Unique = 'UNIQUE', + OutOfScopeApp = 'OUT_OF_SCOPE_APP', + OutOfScopePermission = 'OUT_OF_SCOPE_PERMISSION', +} + +export type AppInput = { + /** Name of the app. */ + name?: Maybe + /** DEPRECATED: Use the `appActivate` and `appDeactivate` mutations instead. This field will be removed after 2020-07-31. */ + isActive?: Maybe + /** List of permission code names to assign to this app. */ + permissions?: Maybe>> +} + +/** Updates an existing app. */ +export type AppUpdate = { + __typename?: 'AppUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + appErrors: Array + app?: Maybe +} + +/** Deletes an app. */ +export type AppDelete = { + __typename?: 'AppDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + appErrors: Array + app?: Maybe +} + +/** Creates a new token. */ +export type AppTokenCreate = { + __typename?: 'AppTokenCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** The newly created authentication token. */ + authToken?: Maybe + appErrors: Array + appToken?: Maybe +} + +export type AppTokenInput = { + /** Name of the token. */ + name?: Maybe + /** ID of app. */ + app: Scalars['ID'] +} + +/** Deletes an authentication token assigned to app. */ +export type AppTokenDelete = { + __typename?: 'AppTokenDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + appErrors: Array + appToken?: Maybe +} + +/** Verify provided app token. */ +export type AppTokenVerify = { + __typename?: 'AppTokenVerify' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Determine if token is valid or not. */ + valid: Scalars['Boolean'] + appErrors: Array +} + +/** Install new app by using app manifest. */ +export type AppInstall = { + __typename?: 'AppInstall' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + appErrors: Array + appInstallation?: Maybe +} + +export type AppInstallInput = { + /** Name of the app to install. */ + appName?: Maybe + /** Url to app's manifest in JSON format. */ + manifestUrl?: Maybe + /** Determine if app will be set active or not. */ + activateAfterInstallation?: Maybe + /** List of permission code names to assign to this app. */ + permissions?: Maybe>> +} + +/** Retry failed installation of new app. */ +export type AppRetryInstall = { + __typename?: 'AppRetryInstall' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + appErrors: Array + appInstallation?: Maybe +} + +/** Delete failed installation. */ +export type AppDeleteFailedInstallation = { + __typename?: 'AppDeleteFailedInstallation' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + appErrors: Array + appInstallation?: Maybe +} + +/** Fetch and validate manifest. */ +export type AppFetchManifest = { + __typename?: 'AppFetchManifest' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + manifest?: Maybe + appErrors: Array +} + +/** The manifest definition. */ +export type Manifest = { + __typename?: 'Manifest' + identifier: Scalars['String'] + version: Scalars['String'] + name: Scalars['String'] + about?: Maybe + permissions?: Maybe>> + appUrl?: Maybe + configurationUrl?: Maybe + tokenTargetUrl?: Maybe + dataPrivacy?: Maybe + dataPrivacyUrl?: Maybe + homepageUrl?: Maybe + supportUrl?: Maybe +} + +/** Activate the app. */ +export type AppActivate = { + __typename?: 'AppActivate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + appErrors: Array + app?: Maybe +} + +/** Deactivate the app. */ +export type AppDeactivate = { + __typename?: 'AppDeactivate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + appErrors: Array + app?: Maybe +} + +/** Create JWT token. */ +export type CreateToken = { + __typename?: 'CreateToken' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** JWT token, required to authenticate. */ + token?: Maybe + /** JWT refresh token, required to re-generate access token. */ + refreshToken?: Maybe + /** CSRF token required to re-generate access token. */ + csrfToken?: Maybe + /** A user instance. */ + user?: Maybe + accountErrors: Array +} + +export type AccountError = { + __typename?: 'AccountError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: AccountErrorCode +} + +/** An enumeration. */ +export enum AccountErrorCode { + ActivateOwnAccount = 'ACTIVATE_OWN_ACCOUNT', + ActivateSuperuserAccount = 'ACTIVATE_SUPERUSER_ACCOUNT', + DuplicatedInputItem = 'DUPLICATED_INPUT_ITEM', + DeactivateOwnAccount = 'DEACTIVATE_OWN_ACCOUNT', + DeactivateSuperuserAccount = 'DEACTIVATE_SUPERUSER_ACCOUNT', + DeleteNonStaffUser = 'DELETE_NON_STAFF_USER', + DeleteOwnAccount = 'DELETE_OWN_ACCOUNT', + DeleteStaffAccount = 'DELETE_STAFF_ACCOUNT', + DeleteSuperuserAccount = 'DELETE_SUPERUSER_ACCOUNT', + GraphqlError = 'GRAPHQL_ERROR', + Inactive = 'INACTIVE', + Invalid = 'INVALID', + InvalidPassword = 'INVALID_PASSWORD', + LeftNotManageablePermission = 'LEFT_NOT_MANAGEABLE_PERMISSION', + InvalidCredentials = 'INVALID_CREDENTIALS', + NotFound = 'NOT_FOUND', + OutOfScopeUser = 'OUT_OF_SCOPE_USER', + OutOfScopeGroup = 'OUT_OF_SCOPE_GROUP', + OutOfScopePermission = 'OUT_OF_SCOPE_PERMISSION', + PasswordEntirelyNumeric = 'PASSWORD_ENTIRELY_NUMERIC', + PasswordTooCommon = 'PASSWORD_TOO_COMMON', + PasswordTooShort = 'PASSWORD_TOO_SHORT', + PasswordTooSimilar = 'PASSWORD_TOO_SIMILAR', + Required = 'REQUIRED', + Unique = 'UNIQUE', + JwtSignatureExpired = 'JWT_SIGNATURE_EXPIRED', + JwtInvalidToken = 'JWT_INVALID_TOKEN', + JwtDecodeError = 'JWT_DECODE_ERROR', + JwtMissingToken = 'JWT_MISSING_TOKEN', + JwtInvalidCsrfToken = 'JWT_INVALID_CSRF_TOKEN', +} + +/** Refresh JWT token. Mutation tries to take refreshToken from the input.If it fails it will try to take refreshToken from the http-only cookie -refreshToken. csrfToken is required when refreshToken is provided as a cookie. */ +export type RefreshToken = { + __typename?: 'RefreshToken' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** JWT token, required to authenticate. */ + token?: Maybe + /** A user instance. */ + user?: Maybe + accountErrors: Array +} + +/** Verify JWT token. */ +export type VerifyToken = { + __typename?: 'VerifyToken' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** User assigned to token. */ + user?: Maybe + /** Determine if token is valid or not. */ + isValid: Scalars['Boolean'] + /** JWT payload. */ + payload?: Maybe + accountErrors: Array +} + +/** Deactivate all JWT tokens of the currently authenticated user. */ +export type DeactivateAllUserTokens = { + __typename?: 'DeactivateAllUserTokens' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + accountErrors: Array +} + +/** Prepare external authentication url for user by custom plugin. */ +export type ExternalAuthenticationUrl = { + __typename?: 'ExternalAuthenticationUrl' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** The data returned by authentication plugin. */ + authenticationData?: Maybe + accountErrors: Array +} + +/** Obtain external access tokens for user by custom plugin. */ +export type ExternalObtainAccessTokens = { + __typename?: 'ExternalObtainAccessTokens' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** The token, required to authenticate. */ + token?: Maybe + /** The refresh token, required to re-generate external access token. */ + refreshToken?: Maybe + /** CSRF token required to re-generate external access token. */ + csrfToken?: Maybe + /** A user instance. */ + user?: Maybe + accountErrors: Array +} + +/** Refresh user's access by custom plugin. */ +export type ExternalRefresh = { + __typename?: 'ExternalRefresh' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** The token, required to authenticate. */ + token?: Maybe + /** The refresh token, required to re-generate external access token. */ + refreshToken?: Maybe + /** CSRF token required to re-generate external access token. */ + csrfToken?: Maybe + /** A user instance. */ + user?: Maybe + accountErrors: Array +} + +/** Logout user by custom plugin. */ +export type ExternalLogout = { + __typename?: 'ExternalLogout' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** The data returned by authentication plugin. */ + logoutData?: Maybe + accountErrors: Array +} + +/** Verify external authentication data by plugin. */ +export type ExternalVerify = { + __typename?: 'ExternalVerify' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** User assigned to data. */ + user?: Maybe + /** Determine if authentication data is valid or not. */ + isValid: Scalars['Boolean'] + /** External data. */ + verifyData?: Maybe + accountErrors: Array +} + +/** Sends an email with the account password modification link. */ +export type RequestPasswordReset = { + __typename?: 'RequestPasswordReset' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + accountErrors: Array +} + +/** Confirm user account with token sent by email during registration. */ +export type ConfirmAccount = { + __typename?: 'ConfirmAccount' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An activated user account. */ + user?: Maybe + accountErrors: Array +} + +/** Sets the user's password from the token sent by email using the RequestPasswordReset mutation. */ +export type SetPassword = { + __typename?: 'SetPassword' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** JWT token, required to authenticate. */ + token?: Maybe + /** JWT refresh token, required to re-generate access token. */ + refreshToken?: Maybe + /** CSRF token required to re-generate access token. */ + csrfToken?: Maybe + /** A user instance. */ + user?: Maybe + accountErrors: Array +} + +/** Change the password of the logged in user. */ +export type PasswordChange = { + __typename?: 'PasswordChange' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A user instance with a new password. */ + user?: Maybe + accountErrors: Array +} + +/** Request email change of the logged in user. */ +export type RequestEmailChange = { + __typename?: 'RequestEmailChange' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A user instance. */ + user?: Maybe + accountErrors: Array +} + +/** Confirm the email change of the logged-in user. */ +export type ConfirmEmailChange = { + __typename?: 'ConfirmEmailChange' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A user instance with a new email. */ + user?: Maybe + accountErrors: Array +} + +/** Create a new address for the customer. */ +export type AccountAddressCreate = { + __typename?: 'AccountAddressCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A user instance for which the address was created. */ + user?: Maybe + accountErrors: Array + address?: Maybe
+} + +/** An enumeration. */ +export enum AddressTypeEnum { + Billing = 'BILLING', + Shipping = 'SHIPPING', +} + +/** Updates an address of the logged-in user. */ +export type AccountAddressUpdate = { + __typename?: 'AccountAddressUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A user object for which the address was edited. */ + user?: Maybe + accountErrors: Array + address?: Maybe
+} + +/** Delete an address of the logged-in user. */ +export type AccountAddressDelete = { + __typename?: 'AccountAddressDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A user instance for which the address was deleted. */ + user?: Maybe + accountErrors: Array + address?: Maybe
+} + +/** Sets a default address for the authenticated user. */ +export type AccountSetDefaultAddress = { + __typename?: 'AccountSetDefaultAddress' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated user instance. */ + user?: Maybe + accountErrors: Array +} + +/** Register a new user. */ +export type AccountRegister = { + __typename?: 'AccountRegister' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Informs whether users need to confirm their email address. */ + requiresConfirmation?: Maybe + accountErrors: Array + user?: Maybe +} + +export type AccountRegisterInput = { + /** The email address of the user. */ + email: Scalars['String'] + /** Password. */ + password: Scalars['String'] + /** Base of frontend URL that will be needed to create confirmation URL. */ + redirectUrl?: Maybe + /** User language code. */ + languageCode?: Maybe +} + +/** Updates the account of the logged-in user. */ +export type AccountUpdate = { + __typename?: 'AccountUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + accountErrors: Array + user?: Maybe +} + +export type AccountInput = { + /** Given name. */ + firstName?: Maybe + /** Family name. */ + lastName?: Maybe + /** Billing address of the customer. */ + defaultBillingAddress?: Maybe + /** Shipping address of the customer. */ + defaultShippingAddress?: Maybe + /** User language code. */ + languageCode?: Maybe +} + +/** Sends an email with the account removal link for the logged-in user. */ +export type AccountRequestDeletion = { + __typename?: 'AccountRequestDeletion' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + accountErrors: Array +} + +/** Remove user account. */ +export type AccountDelete = { + __typename?: 'AccountDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + accountErrors: Array + user?: Maybe +} + +/** Creates user address. */ +export type AddressCreate = { + __typename?: 'AddressCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A user instance for which the address was created. */ + user?: Maybe + accountErrors: Array + address?: Maybe
+} + +/** Updates an address. */ +export type AddressUpdate = { + __typename?: 'AddressUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A user object for which the address was edited. */ + user?: Maybe + accountErrors: Array + address?: Maybe
+} + +/** Deletes an address. */ +export type AddressDelete = { + __typename?: 'AddressDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** A user instance for which the address was deleted. */ + user?: Maybe + accountErrors: Array + address?: Maybe
+} + +/** Sets a default address for the given user. */ +export type AddressSetDefault = { + __typename?: 'AddressSetDefault' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated user instance. */ + user?: Maybe + accountErrors: Array +} + +/** Creates a new customer. */ +export type CustomerCreate = { + __typename?: 'CustomerCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + accountErrors: Array + user?: Maybe +} + +export type UserCreateInput = { + /** Billing address of the customer. */ + defaultBillingAddress?: Maybe + /** Shipping address of the customer. */ + defaultShippingAddress?: Maybe + /** Given name. */ + firstName?: Maybe + /** Family name. */ + lastName?: Maybe + /** The unique email address of the user. */ + email?: Maybe + /** User account is active. */ + isActive?: Maybe + /** A note about the user. */ + note?: Maybe + /** User language code. */ + languageCode?: Maybe + /** URL of a view where users should be redirected to set the password. URL in RFC 1808 format. */ + redirectUrl?: Maybe +} + +/** Updates an existing customer. */ +export type CustomerUpdate = { + __typename?: 'CustomerUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + accountErrors: Array + user?: Maybe +} + +export type CustomerInput = { + /** Billing address of the customer. */ + defaultBillingAddress?: Maybe + /** Shipping address of the customer. */ + defaultShippingAddress?: Maybe + /** Given name. */ + firstName?: Maybe + /** Family name. */ + lastName?: Maybe + /** The unique email address of the user. */ + email?: Maybe + /** User account is active. */ + isActive?: Maybe + /** A note about the user. */ + note?: Maybe + /** User language code. */ + languageCode?: Maybe +} + +/** Deletes a customer. */ +export type CustomerDelete = { + __typename?: 'CustomerDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + accountErrors: Array + user?: Maybe +} + +/** Deletes customers. */ +export type CustomerBulkDelete = { + __typename?: 'CustomerBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + accountErrors: Array +} + +/** Creates a new staff user. */ +export type StaffCreate = { + __typename?: 'StaffCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + staffErrors: Array + user?: Maybe +} + +export type StaffError = { + __typename?: 'StaffError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: AccountErrorCode + /** List of permissions which causes the error. */ + permissions?: Maybe> + /** List of permission group IDs which cause the error. */ + groups?: Maybe> + /** List of user IDs which causes the error. */ + users?: Maybe> +} + +export type StaffCreateInput = { + /** Given name. */ + firstName?: Maybe + /** Family name. */ + lastName?: Maybe + /** The unique email address of the user. */ + email?: Maybe + /** User account is active. */ + isActive?: Maybe + /** A note about the user. */ + note?: Maybe + /** List of permission group IDs to which user should be assigned. */ + addGroups?: Maybe> + /** URL of a view where users should be redirected to set the password. URL in RFC 1808 format. */ + redirectUrl?: Maybe +} + +/** Updates an existing staff user. */ +export type StaffUpdate = { + __typename?: 'StaffUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + staffErrors: Array + user?: Maybe +} + +export type StaffUpdateInput = { + /** Given name. */ + firstName?: Maybe + /** Family name. */ + lastName?: Maybe + /** The unique email address of the user. */ + email?: Maybe + /** User account is active. */ + isActive?: Maybe + /** A note about the user. */ + note?: Maybe + /** List of permission group IDs to which user should be assigned. */ + addGroups?: Maybe> + /** List of permission group IDs from which user should be unassigned. */ + removeGroups?: Maybe> +} + +/** Deletes a staff user. */ +export type StaffDelete = { + __typename?: 'StaffDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + staffErrors: Array + user?: Maybe +} + +/** Deletes staff users. */ +export type StaffBulkDelete = { + __typename?: 'StaffBulkDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + staffErrors: Array +} + +/** Create a user avatar. Only for staff members. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec */ +export type UserAvatarUpdate = { + __typename?: 'UserAvatarUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated user instance. */ + user?: Maybe + accountErrors: Array +} + +/** Deletes a user avatar. Only for staff members. */ +export type UserAvatarDelete = { + __typename?: 'UserAvatarDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** An updated user instance. */ + user?: Maybe + accountErrors: Array +} + +/** Activate or deactivate users. */ +export type UserBulkSetActive = { + __typename?: 'UserBulkSetActive' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + /** Returns how many objects were affected. */ + count: Scalars['Int'] + accountErrors: Array +} + +/** Create new permission group. */ +export type PermissionGroupCreate = { + __typename?: 'PermissionGroupCreate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + permissionGroupErrors: Array + group?: Maybe +} + +export type PermissionGroupError = { + __typename?: 'PermissionGroupError' + /** Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. */ + field?: Maybe + /** The error message. */ + message?: Maybe + /** The error code. */ + code: PermissionGroupErrorCode + /** List of permissions which causes the error. */ + permissions?: Maybe> + /** List of user IDs which causes the error. */ + users?: Maybe> +} + +/** An enumeration. */ +export enum PermissionGroupErrorCode { + AssignNonStaffMember = 'ASSIGN_NON_STAFF_MEMBER', + DuplicatedInputItem = 'DUPLICATED_INPUT_ITEM', + CannotRemoveFromLastGroup = 'CANNOT_REMOVE_FROM_LAST_GROUP', + LeftNotManageablePermission = 'LEFT_NOT_MANAGEABLE_PERMISSION', + OutOfScopePermission = 'OUT_OF_SCOPE_PERMISSION', + OutOfScopeUser = 'OUT_OF_SCOPE_USER', + Required = 'REQUIRED', + Unique = 'UNIQUE', +} + +export type PermissionGroupCreateInput = { + /** List of permission code names to assign to this group. */ + addPermissions?: Maybe> + /** List of users to assign to this group. */ + addUsers?: Maybe> + /** Group name. */ + name: Scalars['String'] +} + +/** Update permission group. */ +export type PermissionGroupUpdate = { + __typename?: 'PermissionGroupUpdate' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + permissionGroupErrors: Array + group?: Maybe +} + +export type PermissionGroupUpdateInput = { + /** List of permission code names to assign to this group. */ + addPermissions?: Maybe> + /** List of users to assign to this group. */ + addUsers?: Maybe> + /** Group name. */ + name?: Maybe + /** List of permission code names to unassign from this group. */ + removePermissions?: Maybe> + /** List of users to unassign from this group. */ + removeUsers?: Maybe> +} + +/** Delete permission group. */ +export type PermissionGroupDelete = { + __typename?: 'PermissionGroupDelete' + /** + * List of errors that occurred executing the mutation. + * @deprecated Use typed errors with error codes. This field will be removed after 2020-07-31. + */ + errors: Array + permissionGroupErrors: Array + group?: Maybe +} + +export type GetAllProductPathsQueryVariables = Exact<{ + first?: Maybe + cursor?: Maybe + channel?: Maybe }> -export type Unnamed_1_Query = { __typename?: 'QueryRoot' } & { - pages: { __typename?: 'PageConnection' } & { - edges: Array< - { __typename?: 'PageEdge' } & { - node: { __typename?: 'Page' } & Pick< - Page, - 'id' | 'title' | 'handle' | 'body' | 'bodySummary' | 'url' - > - } - > - } +export type GetAllProductPathsQuery = { __typename?: 'Query' } & { + products?: Maybe< + { __typename?: 'ProductCountableConnection' } & { + pageInfo: { __typename?: 'PageInfo' } & Pick< + PageInfo, + 'hasNextPage' | 'hasPreviousPage' + > + edges: Array< + { __typename?: 'ProductCountableEdge' } & Pick< + ProductCountableEdge, + 'cursor' + > & { node: { __typename?: 'Product' } & Pick } + > + } + > +} + +export type ProductConnnectionFragment = { + __typename?: 'ProductCountableConnection' +} & { + pageInfo: { __typename?: 'PageInfo' } & Pick< + PageInfo, + 'hasNextPage' | 'hasPreviousPage' + > + edges: Array< + { __typename?: 'ProductCountableEdge' } & { + node: { __typename?: 'Product' } & Pick< + Product, + 'id' | 'name' | 'description' | 'slug' + > & { + pricing?: Maybe< + { __typename?: 'ProductPricingInfo' } & { + priceRange?: Maybe< + { __typename?: 'TaxedMoneyRange' } & { + start?: Maybe< + { __typename?: 'TaxedMoney' } & { + net: { __typename?: 'Money' } & Pick + } + > + } + > + } + > + media?: Maybe< + Array< + { __typename?: 'ProductMedia' } & Pick< + ProductMedia, + 'url' | 'alt' + > + > + > + } + } + > +} + +export type GetAllProductsQueryVariables = Exact<{ + first?: Maybe + channel?: Maybe +}> + +export type GetAllProductsQuery = { __typename?: 'Query' } & { + products?: Maybe< + { __typename?: 'ProductCountableConnection' } & ProductConnnectionFragment + > } diff --git a/framework/saleor/schema.graphql b/framework/saleor/schema.graphql index 822e6007e..375d5c940 100644 --- a/framework/saleor/schema.graphql +++ b/framework/saleor/schema.graphql @@ -1,8615 +1,613 @@ -schema { - query: QueryRoot - mutation: Mutation -} - -""" -Marks an element of a GraphQL schema as having restricted access. -""" -directive @accessRestricted( +type Query { """ - Explains the reason around this restriction + Look up a webhook by ID. """ - reason: String = null -) on FIELD_DEFINITION | OBJECT - -""" -A version of the API. -""" -type ApiVersion { - """ - The human-readable name of the version. - """ - displayName: String! - - """ - The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle. - """ - handle: String! - - """ - Whether the version is supported by Shopify. - """ - supported: Boolean! -} - -""" -Details about the gift card used on the checkout. -""" -type AppliedGiftCard implements Node { - """ - The amount that was taken from the gift card by applying it. - """ - amountUsed: Money! @deprecated(reason: "Use `amountUsedV2` instead") - - """ - The amount that was taken from the gift card by applying it. - """ - amountUsedV2: MoneyV2! - - """ - The amount left on the gift card. - """ - balance: Money! @deprecated(reason: "Use `balanceV2` instead") - - """ - The amount left on the gift card. - """ - balanceV2: MoneyV2! - - """ - Globally unique identifier. - """ - id: ID! - - """ - The last characters of the gift card. - """ - lastCharacters: String! - - """ - The amount that was applied to the checkout in its currency. - """ - presentmentAmountUsed: MoneyV2! -} - -""" -An article in an online store blog. -""" -type Article implements Node { - """ - The article's author. - """ - author: ArticleAuthor! @deprecated(reason: "Use `authorV2` instead") - - """ - The article's author. - """ - authorV2: ArticleAuthor - - """ - The blog that the article belongs to. - """ - blog: Blog! - - """ - List of comments posted on the article. - """ - comments( + webhook( """ - Returns up to the first `n` elements from the list. + ID of the webhook. """ - first: Int + id: ID! + ): Webhook + + """ + List of all available webhook events. + """ + webhookEvents: [WebhookEvent] + + """ + Retrieve a sample payload for a given webhook event based on real data. It can be useful for some integrations where sample payload is required. + """ + webhookSamplePayload( + """ + Name of the requested event type. + """ + eventType: WebhookSampleEventTypeEnum! + ): JSONString + + """ + Look up a warehouse by ID. + """ + warehouse( + """ + ID of an warehouse + """ + id: ID! + ): Warehouse + + """ + List of warehouses. + """ + warehouses( + filter: WarehouseFilterInput + sortBy: WarehouseSortingInput """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. + Return the elements in the list that come before the specified cursor. """ before: String """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): CommentConnection! - - """ - Stripped content of the article, single line with HTML tags removed. - """ - content( - """ - Truncates string after the given length. - """ - truncateAt: Int - ): String! - - """ - The content of the article, complete with HTML formatting. - """ - contentHtml: HTML! - - """ - Stripped excerpt of the article, single line with HTML tags removed. - """ - excerpt( - """ - Truncates string after the given length. - """ - truncateAt: Int - ): String - - """ - The excerpt of the article, complete with HTML formatting. - """ - excerptHtml: HTML - - """ - A human-friendly unique string for the Article automatically generated from its title. - """ - handle: String! - - """ - Globally unique identifier. - """ - id: ID! - - """ - The image associated with the article. - """ - image( - """ - Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. - """ - maxWidth: Int - - """ - Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. - """ - maxHeight: Int - - """ - Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. - """ - crop: CropRegion - - """ - Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. - """ - scale: Int = 1 - ): Image - - """ - The date and time when the article was published. - """ - publishedAt: DateTime! - - """ - The article’s SEO information. - """ - seo: SEO - - """ - A categorization that a article can be tagged with. - """ - tags: [String!]! - - """ - The article’s name. - """ - title: String! - - """ - The url pointing to the article accessible from the web. - """ - url: URL! -} - -""" -The author of an article. -""" -type ArticleAuthor { - """ - The author's bio. - """ - bio: String - - """ - The author’s email. - """ - email: String! - - """ - The author's first name. - """ - firstName: String! - - """ - The author's last name. - """ - lastName: String! - - """ - The author's full name. - """ - name: String! -} - -""" -An auto-generated type for paginating through multiple Articles. -""" -type ArticleConnection { - """ - A list of edges. - """ - edges: [ArticleEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one Article and a cursor during pagination. -""" -type ArticleEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of ArticleEdge. - """ - node: Article! -} - -""" -The set of valid sort keys for the Article query. -""" -enum ArticleSortKeys { - """ - Sort by the `title` value. - """ - TITLE - - """ - Sort by the `blog_title` value. - """ - BLOG_TITLE - - """ - Sort by the `author` value. - """ - AUTHOR - - """ - Sort by the `updated_at` value. - """ - UPDATED_AT - - """ - Sort by the `published_at` value. - """ - PUBLISHED_AT - - """ - Sort by the `id` value. - """ - ID - - """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. - """ - RELEVANCE -} - -""" -Represents a generic custom attribute. -""" -type Attribute { - """ - Key or name of the attribute. - """ - key: String! - - """ - Value of the attribute. - """ - value: String -} - -""" -Specifies the input fields required for an attribute. -""" -input AttributeInput { - """ - Key or name of the attribute. - """ - key: String! - - """ - Value of the attribute. - """ - value: String! -} - -""" -Automatic discount applications capture the intentions of a discount that was automatically applied. -""" -type AutomaticDiscountApplication implements DiscountApplication { - """ - The method by which the discount's value is allocated to its entitled items. - """ - allocationMethod: DiscountApplicationAllocationMethod! - - """ - Which lines of targetType that the discount is allocated over. - """ - targetSelection: DiscountApplicationTargetSelection! - - """ - The type of line that the discount is applicable towards. - """ - targetType: DiscountApplicationTargetType! - - """ - The title of the application. - """ - title: String! - - """ - The value of the discount application. - """ - value: PricingValue! -} - -""" -A collection of available shipping rates for a checkout. -""" -type AvailableShippingRates { - """ - Whether or not the shipping rates are ready. - The `shippingRates` field is `null` when this value is `false`. - This field should be polled until its value becomes `true`. - """ - ready: Boolean! - - """ - The fetched shipping rates. `null` until the `ready` field is `true`. - """ - shippingRates: [ShippingRate!] -} - -""" -An online store blog. -""" -type Blog implements Node { - """ - Find an article by its handle. - """ - articleByHandle( - """ - The handle of the article. - """ - handle: String! - ): Article - - """ - List of the blog's articles. - """ - articles( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. + Return the elements in the list that come after the specified cursor. """ after: String """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - - """ - Sort the underlying list by the given key. - """ - sortKey: ArticleSortKeys = ID - - """ - Supported filter parameters: - - `author` - - `blog_title` - - `created_at` - - `tag` - - `updated_at` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String - ): ArticleConnection! - - """ - The authors who have contributed to the blog. - """ - authors: [ArticleAuthor!]! - - """ - A human-friendly unique string for the Blog automatically generated from its title. - """ - handle: String! - - """ - Globally unique identifier. - """ - id: ID! - - """ - The blog's SEO information. - """ - seo: SEO - - """ - The blogs’s title. - """ - title: String! - - """ - The url pointing to the blog accessible from the web. - """ - url: URL! -} - -""" -An auto-generated type for paginating through multiple Blogs. -""" -type BlogConnection { - """ - A list of edges. - """ - edges: [BlogEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one Blog and a cursor during pagination. -""" -type BlogEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of BlogEdge. - """ - node: Blog! -} - -""" -The set of valid sort keys for the Blog query. -""" -enum BlogSortKeys { - """ - Sort by the `handle` value. - """ - HANDLE - - """ - Sort by the `title` value. - """ - TITLE - - """ - Sort by the `id` value. - """ - ID - - """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. - """ - RELEVANCE -} - -""" -Card brand, such as Visa or Mastercard, which can be used for payments. -""" -enum CardBrand { - """ - Visa - """ - VISA - - """ - Mastercard - """ - MASTERCARD - - """ - Discover - """ - DISCOVER - - """ - American Express - """ - AMERICAN_EXPRESS - - """ - Diners Club - """ - DINERS_CLUB - - """ - JCB - """ - JCB -} - -""" -A container for all the information required to checkout items and pay. -""" -type Checkout implements Node { - """ - The gift cards used on the checkout. - """ - appliedGiftCards: [AppliedGiftCard!]! - - """ - The available shipping rates for this Checkout. - Should only be used when checkout `requiresShipping` is `true` and - the shipping address is valid. - """ - availableShippingRates: AvailableShippingRates - - """ - The date and time when the checkout was completed. - """ - completedAt: DateTime - - """ - The date and time when the checkout was created. - """ - createdAt: DateTime! - - """ - The currency code for the Checkout. - """ - currencyCode: CurrencyCode! - - """ - A list of extra information that is added to the checkout. - """ - customAttributes: [Attribute!]! - - """ - The customer associated with the checkout. - """ - customer: Customer - @deprecated( - reason: "This field will always return null. If you have an authentication token for the customer, you can use the `customer` field on the query root to retrieve it." - ) - - """ - Discounts that have been applied on the checkout. - """ - discountApplications( - """ - Returns up to the first `n` elements from the list. + Return the first n elements from the list. """ first: Int """ - Returns the elements that come after the specified cursor. + Return the last n elements from the list. + """ + last: Int + ): WarehouseCountableConnection + + """ + Returns a list of all translatable items of a given kind. + """ + translations( + """ + Kind of objects to retrieve. + """ + kind: TranslatableKinds! + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. """ after: String """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): DiscountApplicationConnection! - - """ - The email attached to this checkout. - """ - email: String - - """ - Globally unique identifier. - """ - id: ID! - - """ - A list of line item objects, each one containing information about an item in the checkout. - """ - lineItems( - """ - Returns up to the first `n` elements from the list. + Return the first n elements from the list. """ first: Int """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. + Return the last n elements from the list. """ last: Int - + ): TranslatableItemConnection + translation( """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): CheckoutLineItemConnection! - - """ - The sum of all the prices of all the items in the checkout. Duties, taxes, shipping and discounts excluded. - """ - lineItemsSubtotalPrice: MoneyV2! - - """ - The note associated with the checkout. - """ - note: String - - """ - The resulting order from a paid checkout. - """ - order: Order - - """ - The Order Status Page for this Checkout, null when checkout is not completed. - """ - orderStatusUrl: URL - - """ - The amount left to be paid. This is equal to the cost of the line items, taxes and shipping minus discounts and gift cards. - """ - paymentDue: Money! @deprecated(reason: "Use `paymentDueV2` instead") - - """ - The amount left to be paid. This is equal to the cost of the line items, duties, taxes and shipping minus discounts and gift cards. - """ - paymentDueV2: MoneyV2! - - """ - Whether or not the Checkout is ready and can be completed. Checkouts may - have asynchronous operations that can take time to finish. If you want - to complete a checkout or ensure all the fields are populated and up to - date, polling is required until the value is true. - """ - ready: Boolean! - - """ - States whether or not the fulfillment requires shipping. - """ - requiresShipping: Boolean! - - """ - The shipping address to where the line items will be shipped. - """ - shippingAddress: MailingAddress - - """ - The discounts that have been allocated onto the shipping line by discount applications. - """ - shippingDiscountAllocations: [DiscountAllocation!]! - - """ - Once a shipping rate is selected by the customer it is transitioned to a `shipping_line` object. - """ - shippingLine: ShippingRate - - """ - Price of the checkout before shipping and taxes. - """ - subtotalPrice: Money! @deprecated(reason: "Use `subtotalPriceV2` instead") - - """ - Price of the checkout before duties, shipping and taxes. - """ - subtotalPriceV2: MoneyV2! - - """ - Specifies if the Checkout is tax exempt. - """ - taxExempt: Boolean! - - """ - Specifies if taxes are included in the line item and shipping line prices. - """ - taxesIncluded: Boolean! - - """ - The sum of all the prices of all the items in the checkout, taxes and discounts included. - """ - totalPrice: Money! @deprecated(reason: "Use `totalPriceV2` instead") - - """ - The sum of all the prices of all the items in the checkout, duties, taxes and discounts included. - """ - totalPriceV2: MoneyV2! - - """ - The sum of all the taxes applied to the line items and shipping lines in the checkout. - """ - totalTax: Money! @deprecated(reason: "Use `totalTaxV2` instead") - - """ - The sum of all the taxes applied to the line items and shipping lines in the checkout. - """ - totalTaxV2: MoneyV2! - - """ - The date and time when the checkout was last updated. - """ - updatedAt: DateTime! - - """ - The url pointing to the checkout accessible from the web. - """ - webUrl: URL! -} - -""" -Specifies the fields required to update a checkout's attributes. -""" -input CheckoutAttributesUpdateInput { - """ - The text of an optional note that a shop owner can attach to the checkout. - """ - note: String - - """ - A list of extra information that is added to the checkout. - """ - customAttributes: [AttributeInput!] - - """ - Allows setting partial addresses on a Checkout, skipping the full validation of attributes. - The required attributes are city, province, and country. - Full validation of the addresses is still done at complete time. - """ - allowPartialAddresses: Boolean -} - -""" -Return type for `checkoutAttributesUpdate` mutation. -""" -type CheckoutAttributesUpdatePayload { - """ - The updated checkout object. - """ - checkout: Checkout! - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Specifies the fields required to update a checkout's attributes. -""" -input CheckoutAttributesUpdateV2Input { - """ - The text of an optional note that a shop owner can attach to the checkout. - """ - note: String - - """ - A list of extra information that is added to the checkout. - """ - customAttributes: [AttributeInput!] - - """ - Allows setting partial addresses on a Checkout, skipping the full validation of attributes. - The required attributes are city, province, and country. - Full validation of the addresses is still done at complete time. - """ - allowPartialAddresses: Boolean -} - -""" -Return type for `checkoutAttributesUpdateV2` mutation. -""" -type CheckoutAttributesUpdateV2Payload { - """ - The updated checkout object. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutCompleteFree` mutation. -""" -type CheckoutCompleteFreePayload { - """ - The updated checkout object. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutCompleteWithCreditCard` mutation. -""" -type CheckoutCompleteWithCreditCardPayload { - """ - The checkout on which the payment was applied. - """ - checkout: Checkout! - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - A representation of the attempted payment. - """ - payment: Payment - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutCompleteWithCreditCardV2` mutation. -""" -type CheckoutCompleteWithCreditCardV2Payload { - """ - The checkout on which the payment was applied. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - A representation of the attempted payment. - """ - payment: Payment - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutCompleteWithTokenizedPayment` mutation. -""" -type CheckoutCompleteWithTokenizedPaymentPayload { - """ - The checkout on which the payment was applied. - """ - checkout: Checkout! - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - A representation of the attempted payment. - """ - payment: Payment - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutCompleteWithTokenizedPaymentV2` mutation. -""" -type CheckoutCompleteWithTokenizedPaymentV2Payload { - """ - The checkout on which the payment was applied. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - A representation of the attempted payment. - """ - payment: Payment - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutCompleteWithTokenizedPaymentV3` mutation. -""" -type CheckoutCompleteWithTokenizedPaymentV3Payload { - """ - The checkout on which the payment was applied. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - A representation of the attempted payment. - """ - payment: Payment - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Specifies the fields required to create a checkout. -""" -input CheckoutCreateInput { - """ - The email with which the customer wants to checkout. - """ - email: String - - """ - A list of line item objects, each one containing information about an item in the checkout. - """ - lineItems: [CheckoutLineItemInput!] - - """ - The shipping address to where the line items will be shipped. - """ - shippingAddress: MailingAddressInput - - """ - The text of an optional note that a shop owner can attach to the checkout. - """ - note: String - - """ - A list of extra information that is added to the checkout. - """ - customAttributes: [AttributeInput!] - - """ - Allows setting partial addresses on a Checkout, skipping the full validation of attributes. - The required attributes are city, province, and country. - Full validation of addresses is still done at complete time. - """ - allowPartialAddresses: Boolean - - """ - The three-letter currency code of one of the shop's enabled presentment currencies. - Including this field creates a checkout in the specified currency. By default, new - checkouts are created in the shop's primary currency. - """ - presentmentCurrencyCode: CurrencyCode -} - -""" -Return type for `checkoutCreate` mutation. -""" -type CheckoutCreatePayload { - """ - The new checkout object. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutCustomerAssociate` mutation. -""" -type CheckoutCustomerAssociatePayload { - """ - The updated checkout object. - """ - checkout: Checkout! - - """ - The associated customer object. - """ - customer: Customer - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! -} - -""" -Return type for `checkoutCustomerAssociateV2` mutation. -""" -type CheckoutCustomerAssociateV2Payload { - """ - The updated checkout object. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - The associated customer object. - """ - customer: Customer - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutCustomerDisassociate` mutation. -""" -type CheckoutCustomerDisassociatePayload { - """ - The updated checkout object. - """ - checkout: Checkout! - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutCustomerDisassociateV2` mutation. -""" -type CheckoutCustomerDisassociateV2Payload { - """ - The updated checkout object. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutDiscountCodeApply` mutation. -""" -type CheckoutDiscountCodeApplyPayload { - """ - The updated checkout object. - """ - checkout: Checkout! - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutDiscountCodeApplyV2` mutation. -""" -type CheckoutDiscountCodeApplyV2Payload { - """ - The updated checkout object. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutDiscountCodeRemove` mutation. -""" -type CheckoutDiscountCodeRemovePayload { - """ - The updated checkout object. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutEmailUpdate` mutation. -""" -type CheckoutEmailUpdatePayload { - """ - The checkout object with the updated email. - """ - checkout: Checkout! - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutEmailUpdateV2` mutation. -""" -type CheckoutEmailUpdateV2Payload { - """ - The checkout object with the updated email. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Possible error codes that could be returned by CheckoutUserError. -""" -enum CheckoutErrorCode { - """ - Input value is blank. - """ - BLANK - - """ - Input value is invalid. - """ - INVALID - - """ - Input value is too long. - """ - TOO_LONG - - """ - Input value is not present. - """ - PRESENT - - """ - Input value should be less than maximum allowed value. - """ - LESS_THAN - - """ - Input value should be greater than or equal to minimum allowed value. - """ - GREATER_THAN_OR_EQUAL_TO - - """ - Input value should be less or equal to maximum allowed value. - """ - LESS_THAN_OR_EQUAL_TO - - """ - Checkout is already completed. - """ - ALREADY_COMPLETED - - """ - Checkout is locked. - """ - LOCKED - - """ - Input value is not supported. - """ - NOT_SUPPORTED - - """ - Input email contains an invalid domain name. - """ - BAD_DOMAIN - - """ - Input Zip is invalid for country provided. - """ - INVALID_FOR_COUNTRY - - """ - Input Zip is invalid for country and province provided. - """ - INVALID_FOR_COUNTRY_AND_PROVINCE - - """ - Invalid state in country. - """ - INVALID_STATE_IN_COUNTRY - - """ - Invalid province in country. - """ - INVALID_PROVINCE_IN_COUNTRY - - """ - Invalid region in country. - """ - INVALID_REGION_IN_COUNTRY - - """ - Shipping rate expired. - """ - SHIPPING_RATE_EXPIRED - - """ - Gift card cannot be applied to a checkout that contains a gift card. - """ - GIFT_CARD_UNUSABLE - - """ - Gift card is disabled. - """ - GIFT_CARD_DISABLED - - """ - Gift card code is invalid. - """ - GIFT_CARD_CODE_INVALID - - """ - Gift card has already been applied. - """ - GIFT_CARD_ALREADY_APPLIED - - """ - Gift card currency does not match checkout currency. - """ - GIFT_CARD_CURRENCY_MISMATCH - - """ - Gift card is expired. - """ - GIFT_CARD_EXPIRED - - """ - Gift card has no funds left. - """ - GIFT_CARD_DEPLETED - - """ - Gift card was not found. - """ - GIFT_CARD_NOT_FOUND - - """ - Cart does not meet discount requirements notice. - """ - CART_DOES_NOT_MEET_DISCOUNT_REQUIREMENTS_NOTICE - - """ - Discount expired. - """ - DISCOUNT_EXPIRED - - """ - Discount disabled. - """ - DISCOUNT_DISABLED - - """ - Discount limit reached. - """ - DISCOUNT_LIMIT_REACHED - - """ - Discount not found. - """ - DISCOUNT_NOT_FOUND - - """ - Customer already used once per customer discount notice. - """ - CUSTOMER_ALREADY_USED_ONCE_PER_CUSTOMER_DISCOUNT_NOTICE - - """ - Checkout is already completed. - """ - EMPTY - - """ - Not enough in stock. - """ - NOT_ENOUGH_IN_STOCK - - """ - Missing payment input. - """ - MISSING_PAYMENT_INPUT - - """ - The amount of the payment does not match the value to be paid. - """ - TOTAL_PRICE_MISMATCH - - """ - Line item was not found in checkout. - """ - LINE_ITEM_NOT_FOUND - - """ - Unable to apply discount. - """ - UNABLE_TO_APPLY - - """ - Discount already applied. - """ - DISCOUNT_ALREADY_APPLIED -} - -""" -Return type for `checkoutGiftCardApply` mutation. -""" -type CheckoutGiftCardApplyPayload { - """ - The updated checkout object. - """ - checkout: Checkout! - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutGiftCardRemove` mutation. -""" -type CheckoutGiftCardRemovePayload { - """ - The updated checkout object. - """ - checkout: Checkout! - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutGiftCardRemoveV2` mutation. -""" -type CheckoutGiftCardRemoveV2Payload { - """ - The updated checkout object. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutGiftCardsAppend` mutation. -""" -type CheckoutGiftCardsAppendPayload { - """ - The updated checkout object. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -A single line item in the checkout, grouped by variant and attributes. -""" -type CheckoutLineItem implements Node { - """ - Extra information in the form of an array of Key-Value pairs about the line item. - """ - customAttributes: [Attribute!]! - - """ - The discounts that have been allocated onto the checkout line item by discount applications. - """ - discountAllocations: [DiscountAllocation!]! - - """ - Globally unique identifier. - """ - id: ID! - - """ - The quantity of the line item. - """ - quantity: Int! - - """ - Title of the line item. Defaults to the product's title. - """ - title: String! - - """ - Unit price of the line item. - """ - unitPrice: MoneyV2 - - """ - Product variant of the line item. - """ - variant: ProductVariant -} - -""" -An auto-generated type for paginating through multiple CheckoutLineItems. -""" -type CheckoutLineItemConnection { - """ - A list of edges. - """ - edges: [CheckoutLineItemEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one CheckoutLineItem and a cursor during pagination. -""" -type CheckoutLineItemEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of CheckoutLineItemEdge. - """ - node: CheckoutLineItem! -} - -""" -Specifies the input fields to create a line item on a checkout. -""" -input CheckoutLineItemInput { - """ - Extra information in the form of an array of Key-Value pairs about the line item. - """ - customAttributes: [AttributeInput!] - - """ - The quantity of the line item. - """ - quantity: Int! - - """ - The identifier of the product variant for the line item. - """ - variantId: ID! -} - -""" -Specifies the input fields to update a line item on the checkout. -""" -input CheckoutLineItemUpdateInput { - """ - The identifier of the line item. - """ - id: ID - - """ - The variant identifier of the line item. - """ - variantId: ID - - """ - The quantity of the line item. - """ - quantity: Int - - """ - Extra information in the form of an array of Key-Value pairs about the line item. - """ - customAttributes: [AttributeInput!] -} - -""" -Return type for `checkoutLineItemsAdd` mutation. -""" -type CheckoutLineItemsAddPayload { - """ - The updated checkout object. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutLineItemsRemove` mutation. -""" -type CheckoutLineItemsRemovePayload { - """ - The updated checkout object. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutLineItemsReplace` mutation. -""" -type CheckoutLineItemsReplacePayload { - """ - The updated checkout object. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [CheckoutUserError!]! -} - -""" -Return type for `checkoutLineItemsUpdate` mutation. -""" -type CheckoutLineItemsUpdatePayload { - """ - The updated checkout object. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutShippingAddressUpdate` mutation. -""" -type CheckoutShippingAddressUpdatePayload { - """ - The updated checkout object. - """ - checkout: Checkout! - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutShippingAddressUpdateV2` mutation. -""" -type CheckoutShippingAddressUpdateV2Payload { - """ - The updated checkout object. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Return type for `checkoutShippingLineUpdate` mutation. -""" -type CheckoutShippingLineUpdatePayload { - """ - The updated checkout object. - """ - checkout: Checkout - - """ - List of errors that occurred executing the mutation. - """ - checkoutUserErrors: [CheckoutUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `checkoutUserErrors` instead") -} - -""" -Represents an error that happens during execution of a checkout mutation. -""" -type CheckoutUserError implements DisplayableError { - """ - Error code to uniquely identify the error. - """ - code: CheckoutErrorCode - - """ - Path to the input field which caused the error. - """ - field: [String!] - - """ - The error message. - """ - message: String! -} - -""" -A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse. -""" -type Collection implements Node { - """ - Stripped description of the collection, single line with HTML tags removed. - """ - description( - """ - Truncates string after the given length. - """ - truncateAt: Int - ): String! - - """ - The description of the collection, complete with HTML formatting. - """ - descriptionHtml: HTML! - - """ - A human-friendly unique string for the collection automatically generated from its title. - Limit of 255 characters. - """ - handle: String! - - """ - Globally unique identifier. - """ - id: ID! - - """ - Image associated with the collection. - """ - image( - """ - Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. - """ - maxWidth: Int - - """ - Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. - """ - maxHeight: Int - - """ - Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. - """ - crop: CropRegion - - """ - Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. - """ - scale: Int = 1 - ): Image - - """ - List of products in the collection. - """ - products( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - - """ - Sort the underlying list by the given key. - """ - sortKey: ProductCollectionSortKeys = COLLECTION_DEFAULT - ): ProductConnection! - - """ - The collection’s name. Limit of 255 characters. - """ - title: String! - - """ - The date and time when the collection was last modified. - """ - updatedAt: DateTime! -} - -""" -An auto-generated type for paginating through multiple Collections. -""" -type CollectionConnection { - """ - A list of edges. - """ - edges: [CollectionEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one Collection and a cursor during pagination. -""" -type CollectionEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of CollectionEdge. - """ - node: Collection! -} - -""" -The set of valid sort keys for the Collection query. -""" -enum CollectionSortKeys { - """ - Sort by the `title` value. - """ - TITLE - - """ - Sort by the `updated_at` value. - """ - UPDATED_AT - - """ - Sort by the `id` value. - """ - ID - - """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. - """ - RELEVANCE -} - -""" -A comment on an article. -""" -type Comment implements Node { - """ - The comment’s author. - """ - author: CommentAuthor! - - """ - Stripped content of the comment, single line with HTML tags removed. - """ - content( - """ - Truncates string after the given length. - """ - truncateAt: Int - ): String! - - """ - The content of the comment, complete with HTML formatting. - """ - contentHtml: HTML! - - """ - Globally unique identifier. - """ - id: ID! -} - -""" -The author of a comment. -""" -type CommentAuthor { - """ - The author's email. - """ - email: String! - - """ - The author’s name. - """ - name: String! -} - -""" -An auto-generated type for paginating through multiple Comments. -""" -type CommentConnection { - """ - A list of edges. - """ - edges: [CommentEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one Comment and a cursor during pagination. -""" -type CommentEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of CommentEdge. - """ - node: Comment! -} - -""" -ISO 3166-1 alpha-2 country codes with some differences. -""" -enum CountryCode { - """ - Afghanistan. - """ - AF - - """ - Åland Islands. - """ - AX - - """ - Albania. - """ - AL - - """ - Algeria. - """ - DZ - - """ - Andorra. - """ - AD - - """ - Angola. - """ - AO - - """ - Anguilla. - """ - AI - - """ - Antigua & Barbuda. - """ - AG - - """ - Argentina. - """ - AR - - """ - Armenia. - """ - AM - - """ - Aruba. - """ - AW - - """ - Australia. - """ - AU - - """ - Austria. - """ - AT - - """ - Azerbaijan. - """ - AZ - - """ - Bahamas. - """ - BS - - """ - Bahrain. - """ - BH - - """ - Bangladesh. - """ - BD - - """ - Barbados. - """ - BB - - """ - Belarus. - """ - BY - - """ - Belgium. - """ - BE - - """ - Belize. - """ - BZ - - """ - Benin. - """ - BJ - - """ - Bermuda. - """ - BM - - """ - Bhutan. - """ - BT - - """ - Bolivia. - """ - BO - - """ - Bosnia & Herzegovina. - """ - BA - - """ - Botswana. - """ - BW - - """ - Bouvet Island. - """ - BV - - """ - Brazil. - """ - BR - - """ - British Indian Ocean Territory. - """ - IO - - """ - Brunei. - """ - BN - - """ - Bulgaria. - """ - BG - - """ - Burkina Faso. - """ - BF - - """ - Burundi. - """ - BI - - """ - Cambodia. - """ - KH - - """ - Canada. - """ - CA - - """ - Cape Verde. - """ - CV - - """ - Caribbean Netherlands. - """ - BQ - - """ - Cayman Islands. - """ - KY - - """ - Central African Republic. - """ - CF - - """ - Chad. - """ - TD - - """ - Chile. - """ - CL - - """ - China. - """ - CN - - """ - Christmas Island. - """ - CX - - """ - Cocos (Keeling) Islands. - """ - CC - - """ - Colombia. - """ - CO - - """ - Comoros. - """ - KM - - """ - Congo - Brazzaville. - """ - CG - - """ - Congo - Kinshasa. - """ - CD - - """ - Cook Islands. - """ - CK - - """ - Costa Rica. - """ - CR - - """ - Croatia. - """ - HR - - """ - Cuba. - """ - CU - - """ - Curaçao. - """ - CW - - """ - Cyprus. - """ - CY - - """ - Czechia. - """ - CZ - - """ - Côte d’Ivoire. - """ - CI - - """ - Denmark. - """ - DK - - """ - Djibouti. - """ - DJ - - """ - Dominica. - """ - DM - - """ - Dominican Republic. - """ - DO - - """ - Ecuador. - """ - EC - - """ - Egypt. - """ - EG - - """ - El Salvador. - """ - SV - - """ - Equatorial Guinea. - """ - GQ - - """ - Eritrea. - """ - ER - - """ - Estonia. - """ - EE - - """ - Eswatini. - """ - SZ - - """ - Ethiopia. - """ - ET - - """ - Falkland Islands. - """ - FK - - """ - Faroe Islands. - """ - FO - - """ - Fiji. - """ - FJ - - """ - Finland. - """ - FI - - """ - France. - """ - FR - - """ - French Guiana. - """ - GF - - """ - French Polynesia. - """ - PF - - """ - French Southern Territories. - """ - TF - - """ - Gabon. - """ - GA - - """ - Gambia. - """ - GM - - """ - Georgia. - """ - GE - - """ - Germany. - """ - DE - - """ - Ghana. - """ - GH - - """ - Gibraltar. - """ - GI - - """ - Greece. - """ - GR - - """ - Greenland. - """ - GL - - """ - Grenada. - """ - GD - - """ - Guadeloupe. - """ - GP - - """ - Guatemala. - """ - GT - - """ - Guernsey. - """ - GG - - """ - Guinea. - """ - GN - - """ - Guinea-Bissau. - """ - GW - - """ - Guyana. - """ - GY - - """ - Haiti. - """ - HT - - """ - Heard & McDonald Islands. - """ - HM - - """ - Vatican City. - """ - VA - - """ - Honduras. - """ - HN - - """ - Hong Kong SAR. - """ - HK - - """ - Hungary. - """ - HU - - """ - Iceland. - """ - IS - - """ - India. - """ - IN - - """ - Indonesia. - """ - ID - - """ - Iran. - """ - IR - - """ - Iraq. - """ - IQ - - """ - Ireland. - """ - IE - - """ - Isle of Man. - """ - IM - - """ - Israel. - """ - IL - - """ - Italy. - """ - IT - - """ - Jamaica. - """ - JM - - """ - Japan. - """ - JP - - """ - Jersey. - """ - JE - - """ - Jordan. - """ - JO - - """ - Kazakhstan. - """ - KZ - - """ - Kenya. - """ - KE - - """ - Kiribati. - """ - KI - - """ - North Korea. - """ - KP - - """ - Kosovo. - """ - XK - - """ - Kuwait. - """ - KW - - """ - Kyrgyzstan. - """ - KG - - """ - Laos. - """ - LA - - """ - Latvia. - """ - LV - - """ - Lebanon. - """ - LB - - """ - Lesotho. - """ - LS - - """ - Liberia. - """ - LR - - """ - Libya. - """ - LY - - """ - Liechtenstein. - """ - LI - - """ - Lithuania. - """ - LT - - """ - Luxembourg. - """ - LU - - """ - Macao SAR. - """ - MO - - """ - Madagascar. - """ - MG - - """ - Malawi. - """ - MW - - """ - Malaysia. - """ - MY - - """ - Maldives. - """ - MV - - """ - Mali. - """ - ML - - """ - Malta. - """ - MT - - """ - Martinique. - """ - MQ - - """ - Mauritania. - """ - MR - - """ - Mauritius. - """ - MU - - """ - Mayotte. - """ - YT - - """ - Mexico. - """ - MX - - """ - Moldova. - """ - MD - - """ - Monaco. - """ - MC - - """ - Mongolia. - """ - MN - - """ - Montenegro. - """ - ME - - """ - Montserrat. - """ - MS - - """ - Morocco. - """ - MA - - """ - Mozambique. - """ - MZ - - """ - Myanmar (Burma). - """ - MM - - """ - Namibia. - """ - NA - - """ - Nauru. - """ - NR - - """ - Nepal. - """ - NP - - """ - Netherlands. - """ - NL - - """ - Netherlands Antilles. - """ - AN - - """ - New Caledonia. - """ - NC - - """ - New Zealand. - """ - NZ - - """ - Nicaragua. - """ - NI - - """ - Niger. - """ - NE - - """ - Nigeria. - """ - NG - - """ - Niue. - """ - NU - - """ - Norfolk Island. - """ - NF - - """ - North Macedonia. - """ - MK - - """ - Norway. - """ - NO - - """ - Oman. - """ - OM - - """ - Pakistan. - """ - PK - - """ - Palestinian Territories. - """ - PS - - """ - Panama. - """ - PA - - """ - Papua New Guinea. - """ - PG - - """ - Paraguay. - """ - PY - - """ - Peru. - """ - PE - - """ - Philippines. - """ - PH - - """ - Pitcairn Islands. - """ - PN - - """ - Poland. - """ - PL - - """ - Portugal. - """ - PT - - """ - Qatar. - """ - QA - - """ - Cameroon. - """ - CM - - """ - Réunion. - """ - RE - - """ - Romania. - """ - RO - - """ - Russia. - """ - RU - - """ - Rwanda. - """ - RW - - """ - St. Barthélemy. - """ - BL - - """ - St. Helena. - """ - SH - - """ - St. Kitts & Nevis. - """ - KN - - """ - St. Lucia. - """ - LC - - """ - St. Martin. - """ - MF - - """ - St. Pierre & Miquelon. - """ - PM - - """ - Samoa. - """ - WS - - """ - San Marino. - """ - SM - - """ - São Tomé & Príncipe. - """ - ST - - """ - Saudi Arabia. - """ - SA - - """ - Senegal. - """ - SN - - """ - Serbia. - """ - RS - - """ - Seychelles. - """ - SC - - """ - Sierra Leone. - """ - SL - - """ - Singapore. - """ - SG - - """ - Sint Maarten. - """ - SX - - """ - Slovakia. - """ - SK - - """ - Slovenia. - """ - SI - - """ - Solomon Islands. - """ - SB - - """ - Somalia. - """ - SO - - """ - South Africa. - """ - ZA - - """ - South Georgia & South Sandwich Islands. - """ - GS - - """ - South Korea. - """ - KR - - """ - South Sudan. - """ - SS - - """ - Spain. - """ - ES - - """ - Sri Lanka. - """ - LK - - """ - St. Vincent & Grenadines. - """ - VC - - """ - Sudan. - """ - SD - - """ - Suriname. - """ - SR - - """ - Svalbard & Jan Mayen. - """ - SJ - - """ - Sweden. - """ - SE - - """ - Switzerland. - """ - CH - - """ - Syria. - """ - SY - - """ - Taiwan. - """ - TW - - """ - Tajikistan. - """ - TJ - - """ - Tanzania. - """ - TZ - - """ - Thailand. - """ - TH - - """ - Timor-Leste. - """ - TL - - """ - Togo. - """ - TG - - """ - Tokelau. - """ - TK - - """ - Tonga. - """ - TO - - """ - Trinidad & Tobago. - """ - TT - - """ - Tunisia. - """ - TN - - """ - Turkey. - """ - TR - - """ - Turkmenistan. - """ - TM - - """ - Turks & Caicos Islands. - """ - TC - - """ - Tuvalu. - """ - TV - - """ - Uganda. - """ - UG - - """ - Ukraine. - """ - UA - - """ - United Arab Emirates. - """ - AE - - """ - United Kingdom. - """ - GB - - """ - United States. - """ - US - - """ - U.S. Outlying Islands. - """ - UM - - """ - Uruguay. - """ - UY - - """ - Uzbekistan. - """ - UZ - - """ - Vanuatu. - """ - VU - - """ - Venezuela. - """ - VE - - """ - Vietnam. - """ - VN - - """ - British Virgin Islands. - """ - VG - - """ - Wallis & Futuna. - """ - WF - - """ - Western Sahara. - """ - EH - - """ - Yemen. - """ - YE - - """ - Zambia. - """ - ZM - - """ - Zimbabwe. - """ - ZW -} - -""" -Credit card information used for a payment. -""" -type CreditCard { - """ - The brand of the credit card. - """ - brand: String - - """ - The expiry month of the credit card. - """ - expiryMonth: Int - - """ - The expiry year of the credit card. - """ - expiryYear: Int - - """ - The credit card's BIN number. - """ - firstDigits: String - - """ - The first name of the card holder. - """ - firstName: String - - """ - The last 4 digits of the credit card. - """ - lastDigits: String - - """ - The last name of the card holder. - """ - lastName: String - - """ - The masked credit card number with only the last 4 digits displayed. - """ - maskedNumber: String -} - -""" -Specifies the fields required to complete a checkout with -a Shopify vaulted credit card payment. -""" -input CreditCardPaymentInput { - """ - The amount of the payment. - """ - amount: Money! - - """ - A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. - """ - idempotencyKey: String! - - """ - The billing address for the payment. - """ - billingAddress: MailingAddressInput! - - """ - The ID returned by Shopify's Card Vault. - """ - vaultId: String! - - """ - Executes the payment in test mode if possible. Defaults to `false`. - """ - test: Boolean -} - -""" -Specifies the fields required to complete a checkout with -a Shopify vaulted credit card payment. -""" -input CreditCardPaymentInputV2 { - """ - The amount and currency of the payment. - """ - paymentAmount: MoneyInput! - - """ - A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. - """ - idempotencyKey: String! - - """ - The billing address for the payment. - """ - billingAddress: MailingAddressInput! - - """ - The ID returned by Shopify's Card Vault. - """ - vaultId: String! - - """ - Executes the payment in test mode if possible. Defaults to `false`. - """ - test: Boolean -} - -""" -The part of the image that should remain after cropping. -""" -enum CropRegion { - """ - Keep the center of the image. - """ - CENTER - - """ - Keep the top of the image. - """ - TOP - - """ - Keep the bottom of the image. - """ - BOTTOM - - """ - Keep the left of the image. - """ - LEFT - - """ - Keep the right of the image. - """ - RIGHT -} - -""" -Currency codes. -""" -enum CurrencyCode { - """ - United States Dollars (USD). - """ - USD - - """ - Euro (EUR). - """ - EUR - - """ - United Kingdom Pounds (GBP). - """ - GBP - - """ - Canadian Dollars (CAD). - """ - CAD - - """ - Afghan Afghani (AFN). - """ - AFN - - """ - Albanian Lek (ALL). - """ - ALL - - """ - Algerian Dinar (DZD). - """ - DZD - - """ - Angolan Kwanza (AOA). - """ - AOA - - """ - Argentine Pesos (ARS). - """ - ARS - - """ - Armenian Dram (AMD). - """ - AMD - - """ - Aruban Florin (AWG). - """ - AWG - - """ - Australian Dollars (AUD). - """ - AUD - - """ - Barbadian Dollar (BBD). - """ - BBD - - """ - Azerbaijani Manat (AZN). - """ - AZN - - """ - Bangladesh Taka (BDT). - """ - BDT - - """ - Bahamian Dollar (BSD). - """ - BSD - - """ - Bahraini Dinar (BHD). - """ - BHD - - """ - Burundian Franc (BIF). - """ - BIF - - """ - Belarusian Ruble (BYN). - """ - BYN - - """ - Belarusian Ruble (BYR). - """ - BYR - - """ - Belize Dollar (BZD). - """ - BZD - - """ - Bermudian Dollar (BMD). - """ - BMD - - """ - Bhutanese Ngultrum (BTN). - """ - BTN - - """ - Bosnia and Herzegovina Convertible Mark (BAM). - """ - BAM - - """ - Brazilian Real (BRL). - """ - BRL - - """ - Bolivian Boliviano (BOB). - """ - BOB - - """ - Botswana Pula (BWP). - """ - BWP - - """ - Brunei Dollar (BND). - """ - BND - - """ - Bulgarian Lev (BGN). - """ - BGN - - """ - Burmese Kyat (MMK). - """ - MMK - - """ - Cambodian Riel. - """ - KHR - - """ - Cape Verdean escudo (CVE). - """ - CVE - - """ - Cayman Dollars (KYD). - """ - KYD - - """ - Central African CFA Franc (XAF). - """ - XAF - - """ - Chilean Peso (CLP). - """ - CLP - - """ - Chinese Yuan Renminbi (CNY). - """ - CNY - - """ - Colombian Peso (COP). - """ - COP - - """ - Comorian Franc (KMF). - """ - KMF - - """ - Congolese franc (CDF). - """ - CDF - - """ - Costa Rican Colones (CRC). - """ - CRC - - """ - Croatian Kuna (HRK). - """ - HRK - - """ - Czech Koruny (CZK). - """ - CZK - - """ - Danish Kroner (DKK). - """ - DKK - - """ - Djiboutian Franc (DJF). - """ - DJF - - """ - Dominican Peso (DOP). - """ - DOP - - """ - East Caribbean Dollar (XCD). - """ - XCD - - """ - Egyptian Pound (EGP). - """ - EGP - - """ - Eritrean Nakfa (ERN). - """ - ERN - - """ - Ethiopian Birr (ETB). - """ - ETB - - """ - Falkland Islands Pounds (FKP). - """ - FKP - - """ - CFP Franc (XPF). - """ - XPF - - """ - Fijian Dollars (FJD). - """ - FJD - - """ - Gibraltar Pounds (GIP). - """ - GIP - - """ - Gambian Dalasi (GMD). - """ - GMD - - """ - Ghanaian Cedi (GHS). - """ - GHS - - """ - Guatemalan Quetzal (GTQ). - """ - GTQ - - """ - Guyanese Dollar (GYD). - """ - GYD - - """ - Georgian Lari (GEL). - """ - GEL - - """ - Guinean Franc (GNF). - """ - GNF - - """ - Haitian Gourde (HTG). - """ - HTG - - """ - Honduran Lempira (HNL). - """ - HNL - - """ - Hong Kong Dollars (HKD). - """ - HKD - - """ - Hungarian Forint (HUF). - """ - HUF - - """ - Icelandic Kronur (ISK). - """ - ISK - - """ - Indian Rupees (INR). - """ - INR - - """ - Indonesian Rupiah (IDR). - """ - IDR - - """ - Israeli New Shekel (NIS). - """ - ILS - - """ - Iranian Rial (IRR). - """ - IRR - - """ - Iraqi Dinar (IQD). - """ - IQD - - """ - Jamaican Dollars (JMD). - """ - JMD - - """ - Japanese Yen (JPY). - """ - JPY - - """ - Jersey Pound. - """ - JEP - - """ - Jordanian Dinar (JOD). - """ - JOD - - """ - Kazakhstani Tenge (KZT). - """ - KZT - - """ - Kenyan Shilling (KES). - """ - KES - - """ - Kiribati Dollar (KID). - """ - KID - - """ - Kuwaiti Dinar (KWD). - """ - KWD - - """ - Kyrgyzstani Som (KGS). - """ - KGS - - """ - Laotian Kip (LAK). - """ - LAK - - """ - Latvian Lati (LVL). - """ - LVL - - """ - Lebanese Pounds (LBP). - """ - LBP - - """ - Lesotho Loti (LSL). - """ - LSL - - """ - Liberian Dollar (LRD). - """ - LRD - - """ - Libyan Dinar (LYD). - """ - LYD - - """ - Lithuanian Litai (LTL). - """ - LTL - - """ - Malagasy Ariary (MGA). - """ - MGA - - """ - Macedonia Denar (MKD). - """ - MKD - - """ - Macanese Pataca (MOP). - """ - MOP - - """ - Malawian Kwacha (MWK). - """ - MWK - - """ - Maldivian Rufiyaa (MVR). - """ - MVR - - """ - Mauritanian Ouguiya (MRU). - """ - MRU - - """ - Mexican Pesos (MXN). - """ - MXN - - """ - Malaysian Ringgits (MYR). - """ - MYR - - """ - Mauritian Rupee (MUR). - """ - MUR - - """ - Moldovan Leu (MDL). - """ - MDL - - """ - Moroccan Dirham. - """ - MAD - - """ - Mongolian Tugrik. - """ - MNT - - """ - Mozambican Metical. - """ - MZN - - """ - Namibian Dollar. - """ - NAD - - """ - Nepalese Rupee (NPR). - """ - NPR - - """ - Netherlands Antillean Guilder. - """ - ANG - - """ - New Zealand Dollars (NZD). - """ - NZD - - """ - Nicaraguan Córdoba (NIO). - """ - NIO - - """ - Nigerian Naira (NGN). - """ - NGN - - """ - Norwegian Kroner (NOK). - """ - NOK - - """ - Omani Rial (OMR). - """ - OMR - - """ - Panamian Balboa (PAB). - """ - PAB - - """ - Pakistani Rupee (PKR). - """ - PKR - - """ - Papua New Guinean Kina (PGK). - """ - PGK - - """ - Paraguayan Guarani (PYG). - """ - PYG - - """ - Peruvian Nuevo Sol (PEN). - """ - PEN - - """ - Philippine Peso (PHP). - """ - PHP - - """ - Polish Zlotych (PLN). - """ - PLN - - """ - Qatari Rial (QAR). - """ - QAR - - """ - Romanian Lei (RON). - """ - RON - - """ - Russian Rubles (RUB). - """ - RUB - - """ - Rwandan Franc (RWF). - """ - RWF - - """ - Samoan Tala (WST). - """ - WST - - """ - Saint Helena Pounds (SHP). - """ - SHP - - """ - Saudi Riyal (SAR). - """ - SAR - - """ - Sao Tome And Principe Dobra (STD). - """ - STD - - """ - Serbian dinar (RSD). - """ - RSD - - """ - Seychellois Rupee (SCR). - """ - SCR - - """ - Sierra Leonean Leone (SLL). - """ - SLL - - """ - Singapore Dollars (SGD). - """ - SGD - - """ - Sudanese Pound (SDG). - """ - SDG - - """ - Somali Shilling (SOS). - """ - SOS - - """ - Syrian Pound (SYP). - """ - SYP - - """ - South African Rand (ZAR). - """ - ZAR - - """ - South Korean Won (KRW). - """ - KRW - - """ - South Sudanese Pound (SSP). - """ - SSP - - """ - Solomon Islands Dollar (SBD). - """ - SBD - - """ - Sri Lankan Rupees (LKR). - """ - LKR - - """ - Surinamese Dollar (SRD). - """ - SRD - - """ - Swazi Lilangeni (SZL). - """ - SZL - - """ - Swedish Kronor (SEK). - """ - SEK - - """ - Swiss Francs (CHF). - """ - CHF - - """ - Taiwan Dollars (TWD). - """ - TWD - - """ - Thai baht (THB). - """ - THB - - """ - Tajikistani Somoni (TJS). - """ - TJS - - """ - Tanzanian Shilling (TZS). - """ - TZS - - """ - Tongan Pa'anga (TOP). - """ - TOP - - """ - Trinidad and Tobago Dollars (TTD). - """ - TTD - - """ - Tunisian Dinar (TND). - """ - TND - - """ - Turkish Lira (TRY). - """ - TRY - - """ - Turkmenistani Manat (TMT). - """ - TMT - - """ - Ugandan Shilling (UGX). - """ - UGX - - """ - Ukrainian Hryvnia (UAH). - """ - UAH - - """ - United Arab Emirates Dirham (AED). - """ - AED - - """ - Uruguayan Pesos (UYU). - """ - UYU - - """ - Uzbekistan som (UZS). - """ - UZS - - """ - Vanuatu Vatu (VUV). - """ - VUV - - """ - Venezuelan Bolivares (VEF). - """ - VEF - - """ - Venezuelan Bolivares (VES). - """ - VES - - """ - Vietnamese đồng (VND). - """ - VND - - """ - West African CFA franc (XOF). - """ - XOF - - """ - Yemeni Rial (YER). - """ - YER - - """ - Zambian Kwacha (ZMW). - """ - ZMW -} - -""" -A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. -""" -type Customer { - """ - Indicates whether the customer has consented to be sent marketing material via email. - """ - acceptsMarketing: Boolean! - - """ - A list of addresses for the customer. - """ - addresses( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): MailingAddressConnection! - - """ - The date and time when the customer was created. - """ - createdAt: DateTime! - - """ - The customer’s default address. - """ - defaultAddress: MailingAddress - - """ - The customer’s name, email or phone number. - """ - displayName: String! - - """ - The customer’s email address. - """ - email: String - - """ - The customer’s first name. - """ - firstName: String - - """ - A unique identifier for the customer. - """ - id: ID! - - """ - The customer's most recently updated, incomplete checkout. - """ - lastIncompleteCheckout: Checkout - - """ - The customer’s last name. - """ - lastName: String - - """ - The orders associated with the customer. - """ - orders( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - - """ - Sort the underlying list by the given key. - """ - sortKey: OrderSortKeys = ID - - """ - Supported filter parameters: - - `processed_at` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String - ): OrderConnection! - - """ - The customer’s phone number. - """ - phone: String - - """ - A comma separated list of tags that have been added to the customer. - Additional access scope required: unauthenticated_read_customer_tags. - """ - tags: [String!]! - - """ - The date and time when the customer information was updated. - """ - updatedAt: DateTime! -} - -""" -A CustomerAccessToken represents the unique token required to make modifications to the customer object. -""" -type CustomerAccessToken { - """ - The customer’s access token. - """ - accessToken: String! - - """ - The date and time when the customer access token expires. - """ - expiresAt: DateTime! -} - -""" -Specifies the input fields required to create a customer access token. -""" -input CustomerAccessTokenCreateInput { - """ - The email associated to the customer. - """ - email: String! - - """ - The login password to be used by the customer. - """ - password: String! -} - -""" -Return type for `customerAccessTokenCreate` mutation. -""" -type CustomerAccessTokenCreatePayload { - """ - The newly created customer access token object. - """ - customerAccessToken: CustomerAccessToken - - """ - List of errors that occurred executing the mutation. - """ - customerUserErrors: [CustomerUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") -} - -""" -Return type for `customerAccessTokenCreateWithMultipass` mutation. -""" -type CustomerAccessTokenCreateWithMultipassPayload { - """ - An access token object associated with the customer. - """ - customerAccessToken: CustomerAccessToken - - """ - List of errors that occurred executing the mutation. - """ - customerUserErrors: [CustomerUserError!]! -} - -""" -Return type for `customerAccessTokenDelete` mutation. -""" -type CustomerAccessTokenDeletePayload { - """ - The destroyed access token. - """ - deletedAccessToken: String - - """ - ID of the destroyed customer access token. - """ - deletedCustomerAccessTokenId: String - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! -} - -""" -Return type for `customerAccessTokenRenew` mutation. -""" -type CustomerAccessTokenRenewPayload { - """ - The renewed customer access token object. - """ - customerAccessToken: CustomerAccessToken - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! -} - -""" -Return type for `customerActivateByUrl` mutation. -""" -type CustomerActivateByUrlPayload { - """ - The customer that was activated. - """ - customer: Customer - - """ - A new customer access token for the customer. - """ - customerAccessToken: CustomerAccessToken - - """ - List of errors that occurred executing the mutation. - """ - customerUserErrors: [CustomerUserError!]! -} - -""" -Specifies the input fields required to activate a customer. -""" -input CustomerActivateInput { - """ - The activation token required to activate the customer. - """ - activationToken: String! - - """ - New password that will be set during activation. - """ - password: String! -} - -""" -Return type for `customerActivate` mutation. -""" -type CustomerActivatePayload { - """ - The customer object. - """ - customer: Customer - - """ - A newly created customer access token object for the customer. - """ - customerAccessToken: CustomerAccessToken - - """ - List of errors that occurred executing the mutation. - """ - customerUserErrors: [CustomerUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") -} - -""" -Return type for `customerAddressCreate` mutation. -""" -type CustomerAddressCreatePayload { - """ - The new customer address object. - """ - customerAddress: MailingAddress - - """ - List of errors that occurred executing the mutation. - """ - customerUserErrors: [CustomerUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") -} - -""" -Return type for `customerAddressDelete` mutation. -""" -type CustomerAddressDeletePayload { - """ - List of errors that occurred executing the mutation. - """ - customerUserErrors: [CustomerUserError!]! - - """ - ID of the deleted customer address. - """ - deletedCustomerAddressId: String - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") -} - -""" -Return type for `customerAddressUpdate` mutation. -""" -type CustomerAddressUpdatePayload { - """ - The customer’s updated mailing address. - """ - customerAddress: MailingAddress - - """ - List of errors that occurred executing the mutation. - """ - customerUserErrors: [CustomerUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") -} - -""" -Specifies the fields required to create a new customer. -""" -input CustomerCreateInput { - """ - The customer’s first name. - """ - firstName: String - - """ - The customer’s last name. - """ - lastName: String - - """ - The customer’s email. - """ - email: String! - - """ - A unique phone number for the customer. - - Formatted using E.164 standard. For example, _+16135551111_. - """ - phone: String - - """ - The login password used by the customer. - """ - password: String! - - """ - Indicates whether the customer has consented to be sent marketing material via email. - """ - acceptsMarketing: Boolean -} - -""" -Return type for `customerCreate` mutation. -""" -type CustomerCreatePayload { - """ - The created customer object. - """ - customer: Customer - - """ - List of errors that occurred executing the mutation. - """ - customerUserErrors: [CustomerUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") -} - -""" -Return type for `customerDefaultAddressUpdate` mutation. -""" -type CustomerDefaultAddressUpdatePayload { - """ - The updated customer object. - """ - customer: Customer - - """ - List of errors that occurred executing the mutation. - """ - customerUserErrors: [CustomerUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") -} - -""" -Possible error codes that could be returned by CustomerUserError. -""" -enum CustomerErrorCode { - """ - Input value is blank. - """ - BLANK - - """ - Input value is invalid. - """ - INVALID - - """ - Input value is already taken. - """ - TAKEN - - """ - Input value is too long. - """ - TOO_LONG - - """ - Input value is too short. - """ - TOO_SHORT - - """ - Unidentified customer. - """ - UNIDENTIFIED_CUSTOMER - - """ - Customer is disabled. - """ - CUSTOMER_DISABLED - - """ - Input password starts or ends with whitespace. - """ - PASSWORD_STARTS_OR_ENDS_WITH_WHITESPACE - - """ - Input contains HTML tags. - """ - CONTAINS_HTML_TAGS - - """ - Input contains URL. - """ - CONTAINS_URL - - """ - Invalid activation token. - """ - TOKEN_INVALID - - """ - Customer already enabled. - """ - ALREADY_ENABLED - - """ - Address does not exist. - """ - NOT_FOUND - - """ - Input email contains an invalid domain name. - """ - BAD_DOMAIN - - """ - Multipass token is not valid. - """ - INVALID_MULTIPASS_REQUEST -} - -""" -Return type for `customerRecover` mutation. -""" -type CustomerRecoverPayload { - """ - List of errors that occurred executing the mutation. - """ - customerUserErrors: [CustomerUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") -} - -""" -Return type for `customerResetByUrl` mutation. -""" -type CustomerResetByUrlPayload { - """ - The customer object which was reset. - """ - customer: Customer - - """ - A newly created customer access token object for the customer. - """ - customerAccessToken: CustomerAccessToken - - """ - List of errors that occurred executing the mutation. - """ - customerUserErrors: [CustomerUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") -} - -""" -Specifies the fields required to reset a customer’s password. -""" -input CustomerResetInput { - """ - The reset token required to reset the customer’s password. - """ - resetToken: String! - - """ - New password that will be set as part of the reset password process. - """ - password: String! -} - -""" -Return type for `customerReset` mutation. -""" -type CustomerResetPayload { - """ - The customer object which was reset. - """ - customer: Customer - - """ - A newly created customer access token object for the customer. - """ - customerAccessToken: CustomerAccessToken - - """ - List of errors that occurred executing the mutation. - """ - customerUserErrors: [CustomerUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") -} - -""" -Specifies the fields required to update the Customer information. -""" -input CustomerUpdateInput { - """ - The customer’s first name. - """ - firstName: String - - """ - The customer’s last name. - """ - lastName: String - - """ - The customer’s email. - """ - email: String - - """ - A unique phone number for the customer. - - Formatted using E.164 standard. For example, _+16135551111_. To remove the phone number, specify `null`. - """ - phone: String - - """ - The login password used by the customer. - """ - password: String - - """ - Indicates whether the customer has consented to be sent marketing material via email. - """ - acceptsMarketing: Boolean -} - -""" -Return type for `customerUpdate` mutation. -""" -type CustomerUpdatePayload { - """ - The updated customer object. - """ - customer: Customer - - """ - The newly created customer access token. If the customer's password is updated, all previous access tokens - (including the one used to perform this mutation) become invalid, and a new token is generated. - """ - customerAccessToken: CustomerAccessToken - - """ - List of errors that occurred executing the mutation. - """ - customerUserErrors: [CustomerUserError!]! - - """ - List of errors that occurred executing the mutation. - """ - userErrors: [UserError!]! - @deprecated(reason: "Use `customerUserErrors` instead") -} - -""" -Represents an error that happens during execution of a customer mutation. -""" -type CustomerUserError implements DisplayableError { - """ - Error code to uniquely identify the error. - """ - code: CustomerErrorCode - - """ - Path to the input field which caused the error. - """ - field: [String!] - - """ - The error message. - """ - message: String! -} - -""" -An ISO-8601 encoded UTC date time string. Example value: `"2019-07-03T20:47:55Z"`. -""" -scalar DateTime - -""" -A signed decimal number, which supports arbitrary precision and is serialized as a string. Example value: `"29.99"`. -""" -scalar Decimal - -""" -Digital wallet, such as Apple Pay, which can be used for accelerated checkouts. -""" -enum DigitalWallet { - """ - Apple Pay. - """ - APPLE_PAY - - """ - Android Pay. - """ - ANDROID_PAY - - """ - Google Pay. - """ - GOOGLE_PAY - - """ - Shopify Pay. - """ - SHOPIFY_PAY -} - -""" -An amount discounting the line that has been allocated by a discount. -""" -type DiscountAllocation { - """ - Amount of discount allocated. - """ - allocatedAmount: MoneyV2! - - """ - The discount this allocated amount originated from. - """ - discountApplication: DiscountApplication! -} - -""" -Discount applications capture the intentions of a discount source at -the time of application. -""" -interface DiscountApplication { - """ - The method by which the discount's value is allocated to its entitled items. - """ - allocationMethod: DiscountApplicationAllocationMethod! - - """ - Which lines of targetType that the discount is allocated over. - """ - targetSelection: DiscountApplicationTargetSelection! - - """ - The type of line that the discount is applicable towards. - """ - targetType: DiscountApplicationTargetType! - - """ - The value of the discount application. - """ - value: PricingValue! -} - -""" -The method by which the discount's value is allocated onto its entitled lines. -""" -enum DiscountApplicationAllocationMethod { - """ - The value is spread across all entitled lines. - """ - ACROSS - - """ - The value is applied onto every entitled line. - """ - EACH - - """ - The value is specifically applied onto a particular line. - """ - ONE -} - -""" -An auto-generated type for paginating through multiple DiscountApplications. -""" -type DiscountApplicationConnection { - """ - A list of edges. - """ - edges: [DiscountApplicationEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one DiscountApplication and a cursor during pagination. -""" -type DiscountApplicationEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of DiscountApplicationEdge. - """ - node: DiscountApplication! -} - -""" -Which lines on the order that the discount is allocated over, of the type -defined by the Discount Application's target_type. -""" -enum DiscountApplicationTargetSelection { - """ - The discount is allocated onto all the lines. - """ - ALL - - """ - The discount is allocated onto only the lines it is entitled for. - """ - ENTITLED - - """ - The discount is allocated onto explicitly chosen lines. - """ - EXPLICIT -} - -""" -The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards. -""" -enum DiscountApplicationTargetType { - """ - The discount applies onto line items. - """ - LINE_ITEM - - """ - The discount applies onto shipping lines. - """ - SHIPPING_LINE -} - -""" -Discount code applications capture the intentions of a discount code at -the time that it is applied. -""" -type DiscountCodeApplication implements DiscountApplication { - """ - The method by which the discount's value is allocated to its entitled items. - """ - allocationMethod: DiscountApplicationAllocationMethod! - - """ - Specifies whether the discount code was applied successfully. - """ - applicable: Boolean! - - """ - The string identifying the discount code that was used at the time of application. - """ - code: String! - - """ - Which lines of targetType that the discount is allocated over. - """ - targetSelection: DiscountApplicationTargetSelection! - - """ - The type of line that the discount is applicable towards. - """ - targetType: DiscountApplicationTargetType! - - """ - The value of the discount application. - """ - value: PricingValue! -} - -""" -Represents an error in the input of a mutation. -""" -interface DisplayableError { - """ - Path to the input field which caused the error. - """ - field: [String!] - - """ - The error message. - """ - message: String! -} - -""" -Represents a web address. -""" -type Domain { - """ - The host name of the domain (eg: `example.com`). - """ - host: String! - - """ - Whether SSL is enabled or not. - """ - sslEnabled: Boolean! - - """ - The URL of the domain (eg: `https://example.com`). - """ - url: URL! -} - -""" -Represents a video hosted outside of Shopify. -""" -type ExternalVideo implements Node & Media { - """ - A word or phrase to share the nature or contents of a media. - """ - alt: String - - """ - The URL. - """ - embeddedUrl: URL! - - """ - Globally unique identifier. - """ - id: ID! - - """ - The media content type. - """ - mediaContentType: MediaContentType! - - """ - The preview image for the media. - """ - previewImage: Image -} - -""" -Represents a single fulfillment in an order. -""" -type Fulfillment { - """ - List of the fulfillment's line items. - """ - fulfillmentLineItems( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): FulfillmentLineItemConnection! - - """ - The name of the tracking company. - """ - trackingCompany: String - - """ - Tracking information associated with the fulfillment, - such as the tracking number and tracking URL. - """ - trackingInfo( - """ - Truncate the array result to this size. - """ - first: Int - ): [FulfillmentTrackingInfo!]! -} - -""" -Represents a single line item in a fulfillment. There is at most one fulfillment line item for each order line item. -""" -type FulfillmentLineItem { - """ - The associated order's line item. - """ - lineItem: OrderLineItem! - - """ - The amount fulfilled in this fulfillment. - """ - quantity: Int! -} - -""" -An auto-generated type for paginating through multiple FulfillmentLineItems. -""" -type FulfillmentLineItemConnection { - """ - A list of edges. - """ - edges: [FulfillmentLineItemEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination. -""" -type FulfillmentLineItemEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of FulfillmentLineItemEdge. - """ - node: FulfillmentLineItem! -} - -""" -Tracking information associated with the fulfillment. -""" -type FulfillmentTrackingInfo { - """ - The tracking number of the fulfillment. - """ - number: String - - """ - The URL to track the fulfillment. - """ - url: URL -} - -""" -A string containing HTML code. Example value: `"

Grey cotton knit sweater.

"`. -""" -scalar HTML - -""" -Represents information about the metafields associated to the specified resource. -""" -interface HasMetafields { - """ - The metafield associated with the resource. - """ - metafield( - """ - Container for a set of metafields (maximum of 20 characters). - """ - namespace: String! - - """ - Identifier for the metafield (maximum of 30 characters). - """ - key: String! - ): Metafield - - """ - A paginated list of metafields associated with the resource. - """ - metafields( - """ - Container for a set of metafields (maximum of 20 characters). - """ - namespace: String - - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): MetafieldConnection! -} - -""" -Represents an image resource. -""" -type Image { - """ - A word or phrase to share the nature or contents of an image. - """ - altText: String - - """ - The original height of the image in pixels. Returns `null` if the image is not hosted by Shopify. - """ - height: Int - - """ - A unique identifier for the image. - """ - id: ID - - """ - The location of the original image as a URL. - - If there are any existing transformations in the original source URL, they will remain and not be stripped. - """ - originalSrc: URL! - - """ - The location of the image as a URL. - """ - src: URL! - @deprecated( - reason: "Previously an image had a single `src` field. This could either return the original image\nlocation or a URL that contained transformations such as sizing or scale.\n\nThese transformations were specified by arguments on the parent field.\n\nNow an image has two distinct URL fields: `originalSrc` and `transformedSrc`.\n\n* `originalSrc` - the original unmodified image URL\n* `transformedSrc` - the image URL with the specified transformations included\n\nTo migrate to the new fields, image transformations should be moved from the parent field to `transformedSrc`.\n\nBefore:\n```graphql\n{\n shop {\n productImages(maxWidth: 200, scale: 2) {\n edges {\n node {\n src\n }\n }\n }\n }\n}\n```\n\nAfter:\n```graphql\n{\n shop {\n productImages {\n edges {\n node {\n transformedSrc(maxWidth: 200, scale: 2)\n }\n }\n }\n }\n}\n```\n" - ) - - """ - The location of the transformed image as a URL. - - All transformation arguments are considered "best-effort". If they can be applied to an image, they will be. - Otherwise any transformations which an image type does not support will be ignored. - """ - transformedSrc( - """ - Image width in pixels between 1 and 5760. - """ - maxWidth: Int - - """ - Image height in pixels between 1 and 5760. - """ - maxHeight: Int - - """ - Crops the image according to the specified region. - """ - crop: CropRegion - - """ - Image size multiplier for high-resolution retina displays. Must be between 1 and 3. - """ - scale: Int = 1 - - """ - Best effort conversion of image into content type (SVG -> PNG, Anything -> JGP, Anything -> WEBP are supported). - """ - preferredContentType: ImageContentType - ): URL! - - """ - The original width of the image in pixels. Returns `null` if the image is not hosted by Shopify. - """ - width: Int -} - -""" -An auto-generated type for paginating through multiple Images. -""" -type ImageConnection { - """ - A list of edges. - """ - edges: [ImageEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -List of supported image content types. -""" -enum ImageContentType { - """ - A PNG image. - """ - PNG - - """ - A JPG image. - """ - JPG - - """ - A WEBP image. - """ - WEBP -} - -""" -An auto-generated type which holds one Image and a cursor during pagination. -""" -type ImageEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of ImageEdge. - """ - node: Image! -} - -""" -Represents a mailing address for customers and shipping. -""" -type MailingAddress implements Node { - """ - The first line of the address. Typically the street address or PO Box number. - """ - address1: String - - """ - The second line of the address. Typically the number of the apartment, suite, or unit. - """ - address2: String - - """ - The name of the city, district, village, or town. - """ - city: String - - """ - The name of the customer's company or organization. - """ - company: String - - """ - The name of the country. - """ - country: String - - """ - The two-letter code for the country of the address. - - For example, US. - """ - countryCode: String @deprecated(reason: "Use `countryCodeV2` instead") - - """ - The two-letter code for the country of the address. - - For example, US. - """ - countryCodeV2: CountryCode - - """ - The first name of the customer. - """ - firstName: String - - """ - A formatted version of the address, customized by the provided arguments. - """ - formatted( - """ - Whether to include the customer's name in the formatted address. - """ - withName: Boolean = false - - """ - Whether to include the customer's company in the formatted address. - """ - withCompany: Boolean = true - ): [String!]! - - """ - A comma-separated list of the values for city, province, and country. - """ - formattedArea: String - - """ - Globally unique identifier. - """ - id: ID! - - """ - The last name of the customer. - """ - lastName: String - - """ - The latitude coordinate of the customer address. - """ - latitude: Float - - """ - The longitude coordinate of the customer address. - """ - longitude: Float - - """ - The full name of the customer, based on firstName and lastName. - """ - name: String - - """ - A unique phone number for the customer. - - Formatted using E.164 standard. For example, _+16135551111_. - """ - phone: String - - """ - The region of the address, such as the province, state, or district. - """ - province: String - - """ - The two-letter code for the region. - - For example, ON. - """ - provinceCode: String - - """ - The zip or postal code of the address. - """ - zip: String -} - -""" -An auto-generated type for paginating through multiple MailingAddresses. -""" -type MailingAddressConnection { - """ - A list of edges. - """ - edges: [MailingAddressEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one MailingAddress and a cursor during pagination. -""" -type MailingAddressEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of MailingAddressEdge. - """ - node: MailingAddress! -} - -""" -Specifies the fields accepted to create or update a mailing address. -""" -input MailingAddressInput { - """ - The first line of the address. Typically the street address or PO Box number. - """ - address1: String - - """ - The second line of the address. Typically the number of the apartment, suite, or unit. - """ - address2: String - - """ - The name of the city, district, village, or town. - """ - city: String - - """ - The name of the customer's company or organization. - """ - company: String - - """ - The name of the country. - """ - country: String - - """ - The first name of the customer. - """ - firstName: String - - """ - The last name of the customer. - """ - lastName: String - - """ - A unique phone number for the customer. - - Formatted using E.164 standard. For example, _+16135551111_. - """ - phone: String - - """ - The region of the address, such as the province, state, or district. - """ - province: String - - """ - The zip or postal code of the address. - """ - zip: String -} - -""" -Manual discount applications capture the intentions of a discount that was manually created. -""" -type ManualDiscountApplication implements DiscountApplication { - """ - The method by which the discount's value is allocated to its entitled items. - """ - allocationMethod: DiscountApplicationAllocationMethod! - - """ - The description of the application. - """ - description: String - - """ - Which lines of targetType that the discount is allocated over. - """ - targetSelection: DiscountApplicationTargetSelection! - - """ - The type of line that the discount is applicable towards. - """ - targetType: DiscountApplicationTargetType! - - """ - The title of the application. - """ - title: String! - - """ - The value of the discount application. - """ - value: PricingValue! -} - -""" -Represents a media interface. -""" -interface Media { - """ - A word or phrase to share the nature or contents of a media. - """ - alt: String - - """ - The media content type. - """ - mediaContentType: MediaContentType! - - """ - The preview image for the media. - """ - previewImage: Image -} - -""" -An auto-generated type for paginating through multiple Media. -""" -type MediaConnection { - """ - A list of edges. - """ - edges: [MediaEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -The possible content types for a media object. -""" -enum MediaContentType { - """ - An externally hosted video. - """ - EXTERNAL_VIDEO - - """ - A Shopify hosted image. - """ - IMAGE - - """ - A 3d model. - """ - MODEL_3D - - """ - A Shopify hosted video. - """ - VIDEO -} - -""" -An auto-generated type which holds one Media and a cursor during pagination. -""" -type MediaEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of MediaEdge. - """ - node: Media! -} - -""" -Represents a Shopify hosted image. -""" -type MediaImage implements Node & Media { - """ - A word or phrase to share the nature or contents of a media. - """ - alt: String - - """ - Globally unique identifier. - """ - id: ID! - - """ - The image for the media. - """ - image: Image - - """ - The media content type. - """ - mediaContentType: MediaContentType! - - """ - The preview image for the media. - """ - previewImage: Image -} - -""" -Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are -comprised of keys, values, and value types. -""" -type Metafield implements Node { - """ - The date and time when the storefront metafield was created. - """ - createdAt: DateTime! - - """ - The description of a metafield. - """ - description: String - - """ - Globally unique identifier. - """ - id: ID! - - """ - The key name for a metafield. - """ - key: String! - - """ - The namespace for a metafield. - """ - namespace: String! - - """ - The parent object that the metafield belongs to. - """ - parentResource: MetafieldParentResource! - - """ - The date and time when the storefront metafield was updated. - """ - updatedAt: DateTime! - - """ - The value of a metafield. - """ - value: String! - - """ - Represents the metafield value type. - """ - valueType: MetafieldValueType! -} - -""" -An auto-generated type for paginating through multiple Metafields. -""" -type MetafieldConnection { - """ - A list of edges. - """ - edges: [MetafieldEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one Metafield and a cursor during pagination. -""" -type MetafieldEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of MetafieldEdge. - """ - node: Metafield! -} - -""" -A resource that the metafield belongs to. -""" -union MetafieldParentResource = Product | ProductVariant - -""" -Metafield value types. -""" -enum MetafieldValueType { - """ - A string metafield. - """ - STRING - - """ - An integer metafield. - """ - INTEGER - - """ - A json string metafield. - """ - JSON_STRING -} - -""" -Represents a Shopify hosted 3D model. -""" -type Model3d implements Node & Media { - """ - A word or phrase to share the nature or contents of a media. - """ - alt: String - - """ - Globally unique identifier. - """ - id: ID! - - """ - The media content type. - """ - mediaContentType: MediaContentType! - - """ - The preview image for the media. - """ - previewImage: Image - - """ - The sources for a 3d model. - """ - sources: [Model3dSource!]! -} - -""" -Represents a source for a Shopify hosted 3d model. -""" -type Model3dSource { - """ - The filesize of the 3d model. - """ - filesize: Int! - - """ - The format of the 3d model. - """ - format: String! - - """ - The MIME type of the 3d model. - """ - mimeType: String! - - """ - The URL of the 3d model. - """ - url: String! -} - -""" -A monetary value string. Example value: `"100.57"`. -""" -scalar Money - -""" -Specifies the fields for a monetary value with currency. -""" -input MoneyInput { - """ - Decimal money amount. - """ - amount: Decimal! - - """ - Currency of the money. - """ - currencyCode: CurrencyCode! -} - -""" -A monetary value with currency. - -To format currencies, combine this type's amount and currencyCode fields with your client's locale. - -For example, in JavaScript you could use Intl.NumberFormat: - -```js -new Intl.NumberFormat(locale, { - style: 'currency', - currency: currencyCode -}).format(amount); -``` - -Other formatting libraries include: - -* iOS - [NumberFormatter](https://developer.apple.com/documentation/foundation/numberformatter) -* Android - [NumberFormat](https://developer.android.com/reference/java/text/NumberFormat.html) -* PHP - [NumberFormatter](http://php.net/manual/en/class.numberformatter.php) - -For a more general solution, the [Unicode CLDR number formatting database] is available with many implementations -(such as [TwitterCldr](https://github.com/twitter/twitter-cldr-rb)). -""" -type MoneyV2 { - """ - Decimal money amount. - """ - amount: Decimal! - - """ - Currency of the money. - """ - currencyCode: CurrencyCode! -} - -""" -An auto-generated type for paginating through multiple MoneyV2s. -""" -type MoneyV2Connection { - """ - A list of edges. - """ - edges: [MoneyV2Edge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one MoneyV2 and a cursor during pagination. -""" -type MoneyV2Edge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of MoneyV2Edge. - """ - node: MoneyV2! -} - -""" -The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. -""" -type Mutation { - """ - Updates the attributes of a checkout. - """ - checkoutAttributesUpdate( - """ - The ID of the checkout. - """ - checkoutId: ID! - - """ - The fields used to update a checkout's attributes. - """ - input: CheckoutAttributesUpdateInput! - ): CheckoutAttributesUpdatePayload - @deprecated(reason: "Use `checkoutAttributesUpdateV2` instead") - - """ - Updates the attributes of a checkout. - """ - checkoutAttributesUpdateV2( - """ - The ID of the checkout. - """ - checkoutId: ID! - - """ - The checkout attributes to update. - """ - input: CheckoutAttributesUpdateV2Input! - ): CheckoutAttributesUpdateV2Payload - - """ - Completes a checkout without providing payment information. You can use this mutation for free items or items whose purchase price is covered by a gift card. - """ - checkoutCompleteFree( - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutCompleteFreePayload - - """ - Completes a checkout using a credit card token from Shopify's Vault. - """ - checkoutCompleteWithCreditCard( - """ - The ID of the checkout. - """ - checkoutId: ID! - - """ - The credit card info to apply as a payment. - """ - payment: CreditCardPaymentInput! - ): CheckoutCompleteWithCreditCardPayload - @deprecated(reason: "Use `checkoutCompleteWithCreditCardV2` instead") - - """ - Completes a checkout using a credit card token from Shopify's card vault. Before you can complete checkouts using CheckoutCompleteWithCreditCardV2, you need to [_request payment processing_](https://help.shopify.com/api/guides/sales-channel-sdk/getting-started#request-payment-processing). - """ - checkoutCompleteWithCreditCardV2( - """ - The ID of the checkout. - """ - checkoutId: ID! - - """ - The credit card info to apply as a payment. - """ - payment: CreditCardPaymentInputV2! - ): CheckoutCompleteWithCreditCardV2Payload - - """ - Completes a checkout with a tokenized payment. - """ - checkoutCompleteWithTokenizedPayment( - """ - The ID of the checkout. - """ - checkoutId: ID! - - """ - The info to apply as a tokenized payment. - """ - payment: TokenizedPaymentInput! - ): CheckoutCompleteWithTokenizedPaymentPayload - @deprecated(reason: "Use `checkoutCompleteWithTokenizedPaymentV2` instead") - - """ - Completes a checkout with a tokenized payment. - """ - checkoutCompleteWithTokenizedPaymentV2( - """ - The ID of the checkout. - """ - checkoutId: ID! - - """ - The info to apply as a tokenized payment. - """ - payment: TokenizedPaymentInputV2! - ): CheckoutCompleteWithTokenizedPaymentV2Payload - @deprecated(reason: "Use `checkoutCompleteWithTokenizedPaymentV3` instead") - - """ - Completes a checkout with a tokenized payment. - """ - checkoutCompleteWithTokenizedPaymentV3( - """ - The ID of the checkout. - """ - checkoutId: ID! - - """ - The info to apply as a tokenized payment. - """ - payment: TokenizedPaymentInputV3! - ): CheckoutCompleteWithTokenizedPaymentV3Payload - - """ - Creates a new checkout. - """ - checkoutCreate( - """ - The fields used to create a checkout. - """ - input: CheckoutCreateInput! - ): CheckoutCreatePayload - - """ - Associates a customer to the checkout. - """ - checkoutCustomerAssociate( - """ - The ID of the checkout. - """ - checkoutId: ID! - - """ - The customer access token of the customer to associate. - """ - customerAccessToken: String! - ): CheckoutCustomerAssociatePayload - @deprecated(reason: "Use `checkoutCustomerAssociateV2` instead") - - """ - Associates a customer to the checkout. - """ - checkoutCustomerAssociateV2( - """ - The ID of the checkout. - """ - checkoutId: ID! - - """ - The customer access token of the customer to associate. - """ - customerAccessToken: String! - ): CheckoutCustomerAssociateV2Payload - - """ - Disassociates the current checkout customer from the checkout. - """ - checkoutCustomerDisassociate( - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutCustomerDisassociatePayload - @deprecated(reason: "Use `checkoutCustomerDisassociateV2` instead") - - """ - Disassociates the current checkout customer from the checkout. - """ - checkoutCustomerDisassociateV2( - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutCustomerDisassociateV2Payload - - """ - Applies a discount to an existing checkout using a discount code. - """ - checkoutDiscountCodeApply( - """ - The discount code to apply to the checkout. - """ - discountCode: String! - - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutDiscountCodeApplyPayload - @deprecated(reason: "Use `checkoutDiscountCodeApplyV2` instead") - - """ - Applies a discount to an existing checkout using a discount code. - """ - checkoutDiscountCodeApplyV2( - """ - The discount code to apply to the checkout. - """ - discountCode: String! - - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutDiscountCodeApplyV2Payload - - """ - Removes the applied discount from an existing checkout. - """ - checkoutDiscountCodeRemove( - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutDiscountCodeRemovePayload - - """ - Updates the email on an existing checkout. - """ - checkoutEmailUpdate( - """ - The ID of the checkout. - """ - checkoutId: ID! - - """ - The email to update the checkout with. - """ - email: String! - ): CheckoutEmailUpdatePayload - @deprecated(reason: "Use `checkoutEmailUpdateV2` instead") - - """ - Updates the email on an existing checkout. - """ - checkoutEmailUpdateV2( - """ - The ID of the checkout. - """ - checkoutId: ID! - - """ - The email to update the checkout with. - """ - email: String! - ): CheckoutEmailUpdateV2Payload - - """ - Applies a gift card to an existing checkout using a gift card code. This will replace all currently applied gift cards. - """ - checkoutGiftCardApply( - """ - The code of the gift card to apply on the checkout. - """ - giftCardCode: String! - - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutGiftCardApplyPayload - @deprecated(reason: "Use `checkoutGiftCardsAppend` instead") - - """ - Removes an applied gift card from the checkout. - """ - checkoutGiftCardRemove( - """ - The ID of the Applied Gift Card to remove from the Checkout. - """ - appliedGiftCardId: ID! - - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutGiftCardRemovePayload - @deprecated(reason: "Use `checkoutGiftCardRemoveV2` instead") - - """ - Removes an applied gift card from the checkout. - """ - checkoutGiftCardRemoveV2( - """ - The ID of the Applied Gift Card to remove from the Checkout. - """ - appliedGiftCardId: ID! - - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutGiftCardRemoveV2Payload - - """ - Appends gift cards to an existing checkout. - """ - checkoutGiftCardsAppend( - """ - A list of gift card codes to append to the checkout. - """ - giftCardCodes: [String!]! - - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutGiftCardsAppendPayload - - """ - Adds a list of line items to a checkout. - """ - checkoutLineItemsAdd( - """ - A list of line item objects to add to the checkout. - """ - lineItems: [CheckoutLineItemInput!]! - - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutLineItemsAddPayload - - """ - Removes line items from an existing checkout. - """ - checkoutLineItemsRemove( - """ - The checkout on which to remove line items. - """ - checkoutId: ID! - - """ - Line item ids to remove. - """ - lineItemIds: [ID!]! - ): CheckoutLineItemsRemovePayload - - """ - Sets a list of line items to a checkout. - """ - checkoutLineItemsReplace( - """ - A list of line item objects to set on the checkout. - """ - lineItems: [CheckoutLineItemInput!]! - - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutLineItemsReplacePayload - - """ - Updates line items on a checkout. - """ - checkoutLineItemsUpdate( - """ - The checkout on which to update line items. - """ - checkoutId: ID! - - """ - Line items to update. - """ - lineItems: [CheckoutLineItemUpdateInput!]! - ): CheckoutLineItemsUpdatePayload - - """ - Updates the shipping address of an existing checkout. - """ - checkoutShippingAddressUpdate( - """ - The shipping address to where the line items will be shipped. - """ - shippingAddress: MailingAddressInput! - - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutShippingAddressUpdatePayload - @deprecated(reason: "Use `checkoutShippingAddressUpdateV2` instead") - - """ - Updates the shipping address of an existing checkout. - """ - checkoutShippingAddressUpdateV2( - """ - The shipping address to where the line items will be shipped. - """ - shippingAddress: MailingAddressInput! - - """ - The ID of the checkout. - """ - checkoutId: ID! - ): CheckoutShippingAddressUpdateV2Payload - - """ - Updates the shipping lines on an existing checkout. - """ - checkoutShippingLineUpdate( - """ - The ID of the checkout. - """ - checkoutId: ID! - - """ - A unique identifier to a Checkout’s shipping provider, price, and title combination, enabling the customer to select the availableShippingRates. - """ - shippingRateHandle: String! - ): CheckoutShippingLineUpdatePayload - - """ - Creates a customer access token. - The customer access token is required to modify the customer object in any way. - """ - customerAccessTokenCreate( - """ - The fields used to create a customer access token. - """ - input: CustomerAccessTokenCreateInput! - ): CustomerAccessTokenCreatePayload - - """ - Creates a customer access token using a multipass token instead of email and password. - A customer record is created if customer does not exist. If a customer record already - exists but the record is disabled, then it's enabled. - """ - customerAccessTokenCreateWithMultipass( - """ - A valid multipass token to be authenticated. - """ - multipassToken: String! - ): CustomerAccessTokenCreateWithMultipassPayload - - """ - Permanently destroys a customer access token. - """ - customerAccessTokenDelete( - """ - The access token used to identify the customer. - """ - customerAccessToken: String! - ): CustomerAccessTokenDeletePayload - - """ - Renews a customer access token. - - Access token renewal must happen *before* a token expires. - If a token has already expired, a new one should be created instead via `customerAccessTokenCreate`. - """ - customerAccessTokenRenew( - """ - The access token used to identify the customer. - """ - customerAccessToken: String! - ): CustomerAccessTokenRenewPayload - - """ - Activates a customer. - """ - customerActivate( - """ - Specifies the customer to activate. + ID of the object to retrieve. """ id: ID! """ - The fields used to activate a customer. + Kind of the object to retrieve. """ - input: CustomerActivateInput! - ): CustomerActivatePayload + kind: TranslatableKinds! + ): TranslatableItem """ - Activates a customer with the activation url received from `customerCreate`. + Look up a stock by ID """ - customerActivateByUrl( + stock( """ - The customer activation URL. + ID of an warehouse """ - activationUrl: URL! - - """ - A new password set during activation. - """ - password: String! - ): CustomerActivateByUrlPayload + id: ID! + ): Stock """ - Creates a new address for a customer. + List of stocks. """ - customerAddressCreate( - """ - The access token used to identify the customer. - """ - customerAccessToken: String! + stocks( + filter: StockFilterInput """ - The customer mailing address to create. + Return the elements in the list that come before the specified cursor. """ - address: MailingAddressInput! - ): CustomerAddressCreatePayload + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): StockCountableConnection """ - Permanently deletes the address of an existing customer. + Return information about the shop. """ - customerAddressDelete( + shop: Shop! + + """ + Order related settings from site settings. + """ + orderSettings: OrderSettings + + """ + Look up a shipping zone by ID. + """ + shippingZone( """ - Specifies the address to delete. + ID of the shipping zone. """ id: ID! """ - The access token used to identify the customer. + Slug of a channel for which the data should be returned. """ - customerAccessToken: String! - ): CustomerAddressDeletePayload + channel: String + ): ShippingZone """ - Updates the address of an existing customer. + List of the shop's shipping zones. """ - customerAddressUpdate( + shippingZones( """ - The access token used to identify the customer. + Filtering options for shipping zones. """ - customerAccessToken: String! + filter: ShippingZoneFilterInput """ - Specifies the customer address to update. + Slug of a channel for which the data should be returned. + """ + channel: String + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): ShippingZoneCountableConnection + + """ + Look up digital content by ID. + """ + digitalContent( + """ + ID of the digital content. """ id: ID! - - """ - The customer’s mailing address. - """ - address: MailingAddressInput! - ): CustomerAddressUpdatePayload + ): DigitalContent """ - Creates a new customer. + List of digital content. """ - customerCreate( + digitalContents( """ - The fields used to create a new customer. - """ - input: CustomerCreateInput! - ): CustomerCreatePayload - - """ - Updates the default address of an existing customer. - """ - customerDefaultAddressUpdate( - """ - The access token used to identify the customer. - """ - customerAccessToken: String! - - """ - ID of the address to set as the new default for the customer. - """ - addressId: ID! - ): CustomerDefaultAddressUpdatePayload - - """ - Sends a reset password email to the customer, as the first step in the reset password process. - """ - customerRecover( - """ - The email address of the customer to recover. - """ - email: String! - ): CustomerRecoverPayload - - """ - Resets a customer’s password with a token received from `CustomerRecover`. - """ - customerReset( - """ - Specifies the customer to reset. - """ - id: ID! - - """ - The fields used to reset a customer’s password. - """ - input: CustomerResetInput! - ): CustomerResetPayload - - """ - Resets a customer’s password with the reset password url received from `CustomerRecover`. - """ - customerResetByUrl( - """ - The customer's reset password url. - """ - resetUrl: URL! - - """ - New password that will be set as part of the reset password process. - """ - password: String! - ): CustomerResetByUrlPayload - - """ - Updates an existing customer. - """ - customerUpdate( - """ - The access token used to identify the customer. - """ - customerAccessToken: String! - - """ - The customer object input. - """ - customer: CustomerUpdateInput! - ): CustomerUpdatePayload -} - -""" -An object with an ID to support global identification. -""" -interface Node { - """ - Globally unique identifier. - """ - id: ID! -} - -""" -An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. -""" -type Order implements Node { - """ - The reason for the order's cancellation. Returns `null` if the order wasn't canceled. - """ - cancelReason: OrderCancelReason - - """ - The date and time when the order was canceled. Returns null if the order wasn't canceled. - """ - canceledAt: DateTime - - """ - The code of the currency used for the payment. - """ - currencyCode: CurrencyCode! - - """ - The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes are not included unless the order is a taxes-included order. - """ - currentSubtotalPrice: MoneyV2! - - """ - The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed. - """ - currentTotalPrice: MoneyV2! - - """ - The total of all taxes applied to the order, excluding taxes for returned line items. - """ - currentTotalTax: MoneyV2! - - """ - The locale code in which this specific order happened. - """ - customerLocale: String - - """ - The unique URL that the customer can use to access the order. - """ - customerUrl: URL - - """ - Discounts that have been applied on the order. - """ - discountApplications( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. + Return the elements in the list that come before the specified cursor. """ before: String """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): DiscountApplicationConnection! - - """ - Whether the order has had any edits applied or not. - """ - edited: Boolean! - - """ - The customer's email address. - """ - email: String - - """ - The financial status of the order. - """ - financialStatus: OrderFinancialStatus - - """ - The fulfillment status for the order. - """ - fulfillmentStatus: OrderFulfillmentStatus! - - """ - Globally unique identifier. - """ - id: ID! - - """ - List of the order’s line items. - """ - lineItems( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. + Return the elements in the list that come after the specified cursor. """ after: String """ - Returns up to the last `n` elements from the list. + Return the first n elements from the list. """ - last: Int + first: Int """ - Returns the elements that come before the specified cursor. + Return the last n elements from the list. + """ + last: Int + ): DigitalContentCountableConnection + + """ + List of the shop's categories. + """ + categories( + """ + Filtering options for categories. + """ + filter: CategoryFilterInput + + """ + Sort categories. + """ + sortBy: CategorySortingInput + + """ + Filter categories by the nesting level in the category tree. + """ + level: Int + + """ + Return the elements in the list that come before the specified cursor. """ before: String """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): OrderLineItemConnection! - - """ - Unique identifier for the order that appears on the order. - For example, _#1000_ or _Store1001. - """ - name: String! - - """ - A unique numeric identifier for the order for use by shop owner and customer. - """ - orderNumber: Int! - - """ - The total price of the order before any applied edits. - """ - originalTotalPrice: MoneyV2! - - """ - The customer's phone number for receiving SMS notifications. - """ - phone: String - - """ - The date and time when the order was imported. - This value can be set to dates in the past when importing from other systems. - If no value is provided, it will be auto-generated based on current date and time. - """ - processedAt: DateTime! - - """ - The address to where the order will be shipped. - """ - shippingAddress: MailingAddress - - """ - The discounts that have been allocated onto the shipping line by discount applications. - """ - shippingDiscountAllocations: [DiscountAllocation!]! - - """ - The unique URL for the order's status page. - """ - statusUrl: URL! - - """ - Price of the order before shipping and taxes. - """ - subtotalPrice: Money @deprecated(reason: "Use `subtotalPriceV2` instead") - - """ - Price of the order before duties, shipping and taxes. - """ - subtotalPriceV2: MoneyV2 - - """ - List of the order’s successful fulfillments. - """ - successfulFulfillments( - """ - Truncate the array result to this size. - """ - first: Int - ): [Fulfillment!] - - """ - The sum of all the prices of all the items in the order, taxes and discounts included (must be positive). - """ - totalPrice: Money! @deprecated(reason: "Use `totalPriceV2` instead") - - """ - The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). - """ - totalPriceV2: MoneyV2! - - """ - The total amount that has been refunded. - """ - totalRefunded: Money! @deprecated(reason: "Use `totalRefundedV2` instead") - - """ - The total amount that has been refunded. - """ - totalRefundedV2: MoneyV2! - - """ - The total cost of shipping. - """ - totalShippingPrice: Money! - @deprecated(reason: "Use `totalShippingPriceV2` instead") - - """ - The total cost of shipping. - """ - totalShippingPriceV2: MoneyV2! - - """ - The total cost of taxes. - """ - totalTax: Money @deprecated(reason: "Use `totalTaxV2` instead") - - """ - The total cost of taxes. - """ - totalTaxV2: MoneyV2 -} - -""" -Represents the reason for the order's cancellation. -""" -enum OrderCancelReason { - """ - The customer wanted to cancel the order. - """ - CUSTOMER - - """ - The order was fraudulent. - """ - FRAUD - - """ - There was insufficient inventory. - """ - INVENTORY - - """ - Payment was declined. - """ - DECLINED - - """ - The order was canceled for an unlisted reason. - """ - OTHER -} - -""" -An auto-generated type for paginating through multiple Orders. -""" -type OrderConnection { - """ - A list of edges. - """ - edges: [OrderEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one Order and a cursor during pagination. -""" -type OrderEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of OrderEdge. - """ - node: Order! -} - -""" -Represents the order's current financial status. -""" -enum OrderFinancialStatus { - """ - Displayed as **Pending**. - """ - PENDING - - """ - Displayed as **Authorized**. - """ - AUTHORIZED - - """ - Displayed as **Partially paid**. - """ - PARTIALLY_PAID - - """ - Displayed as **Partially refunded**. - """ - PARTIALLY_REFUNDED - - """ - Displayed as **Voided**. - """ - VOIDED - - """ - Displayed as **Paid**. - """ - PAID - - """ - Displayed as **Refunded**. - """ - REFUNDED -} - -""" -Represents the order's current fulfillment status. -""" -enum OrderFulfillmentStatus { - """ - Displayed as **Unfulfilled**. - """ - UNFULFILLED - - """ - Displayed as **Partially fulfilled**. - """ - PARTIALLY_FULFILLED - - """ - Displayed as **Fulfilled**. - """ - FULFILLED - - """ - Displayed as **Restocked**. - """ - RESTOCKED - - """ - Displayed as **Pending fulfillment**. - """ - PENDING_FULFILLMENT - - """ - Displayed as **Open**. - """ - OPEN - - """ - Displayed as **In progress**. - """ - IN_PROGRESS - - """ - Displayed as **Scheduled**. - """ - SCHEDULED -} - -""" -Represents a single line in an order. There is one line item for each distinct product variant. -""" -type OrderLineItem { - """ - The number of entries associated to the line item minus the items that have been removed. - """ - currentQuantity: Int! - - """ - List of custom attributes associated to the line item. - """ - customAttributes: [Attribute!]! - - """ - The discounts that have been allocated onto the order line item by discount applications. - """ - discountAllocations: [DiscountAllocation!]! - - """ - The total price of the line item, including discounts, and displayed in the presentment currency. - """ - discountedTotalPrice: MoneyV2! - - """ - The total price of the line item, not including any discounts. The total price is calculated using the original unit price multiplied by the quantity, and it is displayed in the presentment currency. - """ - originalTotalPrice: MoneyV2! - - """ - The number of products variants associated to the line item. - """ - quantity: Int! - - """ - The title of the product combined with title of the variant. - """ - title: String! - - """ - The product variant object associated to the line item. - """ - variant: ProductVariant -} - -""" -An auto-generated type for paginating through multiple OrderLineItems. -""" -type OrderLineItemConnection { - """ - A list of edges. - """ - edges: [OrderLineItemEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one OrderLineItem and a cursor during pagination. -""" -type OrderLineItemEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of OrderLineItemEdge. - """ - node: OrderLineItem! -} - -""" -The set of valid sort keys for the Order query. -""" -enum OrderSortKeys { - """ - Sort by the `processed_at` value. - """ - PROCESSED_AT - - """ - Sort by the `total_price` value. - """ - TOTAL_PRICE - - """ - Sort by the `id` value. - """ - ID - - """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. - """ - RELEVANCE -} - -""" -Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. -""" -type Page implements Node { - """ - The description of the page, complete with HTML formatting. - """ - body: HTML! - - """ - Summary of the page body. - """ - bodySummary: String! - - """ - The timestamp of the page creation. - """ - createdAt: DateTime! - - """ - A human-friendly unique string for the page automatically generated from its title. - """ - handle: String! - - """ - Globally unique identifier. - """ - id: ID! - - """ - The page's SEO information. - """ - seo: SEO - - """ - The title of the page. - """ - title: String! - - """ - The timestamp of the latest page update. - """ - updatedAt: DateTime! - - """ - The url pointing to the page accessible from the web. - """ - url: URL! -} - -""" -An auto-generated type for paginating through multiple Pages. -""" -type PageConnection { - """ - A list of edges. - """ - edges: [PageEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one Page and a cursor during pagination. -""" -type PageEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of PageEdge. - """ - node: Page! -} - -""" -Information about pagination in a connection. -""" -type PageInfo { - """ - Indicates if there are more pages to fetch. - """ - hasNextPage: Boolean! - - """ - Indicates if there are any pages prior to the current page. - """ - hasPreviousPage: Boolean! -} - -""" -The set of valid sort keys for the Page query. -""" -enum PageSortKeys { - """ - Sort by the `title` value. - """ - TITLE - - """ - Sort by the `updated_at` value. - """ - UPDATED_AT - - """ - Sort by the `id` value. - """ - ID - - """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. - """ - RELEVANCE -} - -""" -A payment applied to a checkout. -""" -type Payment implements Node { - """ - The amount of the payment. - """ - amount: Money! @deprecated(reason: "Use `amountV2` instead") - - """ - The amount of the payment. - """ - amountV2: MoneyV2! - - """ - The billing address for the payment. - """ - billingAddress: MailingAddress - - """ - The checkout to which the payment belongs. - """ - checkout: Checkout! - - """ - The credit card used for the payment in the case of direct payments. - """ - creditCard: CreditCard - - """ - A message describing a processing error during asynchronous processing. - """ - errorMessage: String - - """ - Globally unique identifier. - """ - id: ID! - - """ - A client-side generated token to identify a payment and perform idempotent operations. - """ - idempotencyKey: String - - """ - The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow. - """ - nextActionUrl: URL - - """ - Whether or not the payment is still processing asynchronously. - """ - ready: Boolean! - - """ - A flag to indicate if the payment is to be done in test mode for gateways that support it. - """ - test: Boolean! - - """ - The actual transaction recorded by Shopify after having processed the payment with the gateway. - """ - transaction: Transaction -} - -""" -Settings related to payments. -""" -type PaymentSettings { - """ - List of the card brands which the shop accepts. - """ - acceptedCardBrands: [CardBrand!]! - - """ - The url pointing to the endpoint to vault credit cards. - """ - cardVaultUrl: URL! - - """ - The country where the shop is located. - """ - countryCode: CountryCode! - - """ - The three-letter code for the shop's primary currency. - """ - currencyCode: CurrencyCode! - - """ - A list of enabled currencies (ISO 4217 format) that the shop accepts. Merchants can enable currencies from their Shopify Payments settings in the Shopify admin. - """ - enabledPresentmentCurrencies: [CurrencyCode!]! - - """ - The shop’s Shopify Payments account id. - """ - shopifyPaymentsAccountId: String - - """ - List of the digital wallets which the shop supports. - """ - supportedDigitalWallets: [DigitalWallet!]! -} - -""" -The valid values for the types of payment token. -""" -enum PaymentTokenType { - """ - Apple Pay token type. - """ - APPLE_PAY - - """ - Vault payment token type. - """ - VAULT - - """ - Shopify Pay token type. - """ - SHOPIFY_PAY - - """ - Google Pay token type. - """ - GOOGLE_PAY -} - -""" -The value of the percentage pricing object. -""" -type PricingPercentageValue { - """ - The percentage value of the object. - """ - percentage: Float! -} - -""" -The price value (fixed or percentage) for a discount application. -""" -union PricingValue = MoneyV2 | PricingPercentageValue - -""" -A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. -For example, a digital download (such as a movie, music or ebook file) also qualifies as a product, as do services (such as equipment rental, work for hire, customization of another product or an extended warranty). -""" -type Product implements Node & HasMetafields { - """ - Indicates if at least one product variant is available for sale. - """ - availableForSale: Boolean! - - """ - List of collections a product belongs to. - """ - collections( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. + Return the elements in the list that come after the specified cursor. """ after: String """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): CollectionConnection! - - """ - The compare at price of the product across all variants. - """ - compareAtPriceRange: ProductPriceRange! - - """ - The date and time when the product was created. - """ - createdAt: DateTime! - - """ - Stripped description of the product, single line with HTML tags removed. - """ - description( - """ - Truncates string after the given length. - """ - truncateAt: Int - ): String! - - """ - The description of the product, complete with HTML formatting. - """ - descriptionHtml: HTML! - - """ - A human-friendly unique string for the Product automatically generated from its title. - They are used by the Liquid templating language to refer to objects. - """ - handle: String! - - """ - Globally unique identifier. - """ - id: ID! - - """ - List of images associated with the product. - """ - images( - """ - Returns up to the first `n` elements from the list. + Return the first n elements from the list. """ first: Int """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. + Return the last n elements from the list. """ last: Int + ): CategoryCountableConnection - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - - """ - Sort the underlying list by the given key. - """ - sortKey: ProductImageSortKeys = POSITION - - """ - Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. - """ - maxWidth: Int - - """ - Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. - """ - maxHeight: Int - - """ - Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. - """ - crop: CropRegion - - """ - Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. - """ - scale: Int = 1 - ): ImageConnection! - - """ - The media associated with the product. - """ - media( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - - """ - Sort the underlying list by the given key. - """ - sortKey: ProductMediaSortKeys = POSITION - ): MediaConnection! - - """ - The metafield associated with the resource. - """ - metafield( - """ - Container for a set of metafields (maximum of 20 characters). - """ - namespace: String! - - """ - Identifier for the metafield (maximum of 30 characters). - """ - key: String! - ): Metafield - - """ - A paginated list of metafields associated with the resource. - """ - metafields( - """ - Container for a set of metafields (maximum of 20 characters). - """ - namespace: String - - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): MetafieldConnection! - - """ - The online store URL for the product. - A value of `null` indicates that the product is not published to the Online Store sales channel. - """ - onlineStoreUrl: URL - - """ - List of product options. - """ - options( - """ - Truncate the array result to this size. - """ - first: Int - ): [ProductOption!]! - - """ - List of price ranges in the presentment currencies for this shop. - """ - presentmentPriceRanges( - """ - Specifies the presentment currencies to return a price range in. - """ - presentmentCurrencies: [CurrencyCode!] - - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): ProductPriceRangeConnection! - - """ - The price range. - """ - priceRange: ProductPriceRange! - - """ - A categorization that a product can be tagged with, commonly used for filtering and searching. - """ - productType: String! - - """ - The date and time when the product was published to the channel. - """ - publishedAt: DateTime! - - """ - The product's SEO information. - """ - seo: SEO! - - """ - A comma separated list of tags that have been added to the product. - Additional access scope required for private apps: unauthenticated_read_product_tags. - """ - tags: [String!]! - - """ - The product’s title. - """ - title: String! - - """ - The total quantity of inventory in stock for this Product. - """ - totalInventory: Int - - """ - The date and time when the product was last modified. - A product's `updatedAt` value can change for different reasons. For example, if an order - is placed for a product that has inventory tracking set up, then the inventory adjustment - is counted as an update. - """ - updatedAt: DateTime! - - """ - Find a product’s variant based on its selected options. - This is useful for converting a user’s selection of product options into a single matching variant. - If there is not a variant for the selected options, `null` will be returned. - """ - variantBySelectedOptions( - """ - The input fields used for a selected option. - """ - selectedOptions: [SelectedOptionInput!]! - ): ProductVariant - - """ - List of the product’s variants. - """ - variants( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - - """ - Sort the underlying list by the given key. - """ - sortKey: ProductVariantSortKeys = POSITION - ): ProductVariantConnection! - - """ - The product’s vendor name. - """ - vendor: String! -} - -""" -The set of valid sort keys for the ProductCollection query. -""" -enum ProductCollectionSortKeys { - """ - Sort by the `title` value. - """ - TITLE - - """ - Sort by the `price` value. - """ - PRICE - - """ - Sort by the `best-selling` value. - """ - BEST_SELLING - - """ - Sort by the `created` value. - """ - CREATED - - """ - Sort by the `id` value. - """ - ID - - """ - Sort by the `manual` value. - """ - MANUAL - - """ - Sort by the `collection-default` value. - """ - COLLECTION_DEFAULT - - """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. - """ - RELEVANCE -} - -""" -An auto-generated type for paginating through multiple Products. -""" -type ProductConnection { - """ - A list of edges. - """ - edges: [ProductEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one Product and a cursor during pagination. -""" -type ProductEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of ProductEdge. - """ - node: Product! -} - -""" -The set of valid sort keys for the ProductImage query. -""" -enum ProductImageSortKeys { - """ - Sort by the `created_at` value. - """ - CREATED_AT - - """ - Sort by the `position` value. - """ - POSITION - - """ - Sort by the `id` value. - """ - ID - - """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. - """ - RELEVANCE -} - -""" -The set of valid sort keys for the ProductMedia query. -""" -enum ProductMediaSortKeys { - """ - Sort by the `position` value. - """ - POSITION - - """ - Sort by the `id` value. - """ - ID - - """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. - """ - RELEVANCE -} - -""" -Product property names like "Size", "Color", and "Material" that the customers can select. -Variants are selected based on permutations of these options. -255 characters limit each. -""" -type ProductOption implements Node { - """ - Globally unique identifier. - """ - id: ID! - - """ - The product option’s name. - """ - name: String! - - """ - The corresponding value to the product option name. - """ - values: [String!]! -} - -""" -The price range of the product. -""" -type ProductPriceRange { - """ - The highest variant's price. - """ - maxVariantPrice: MoneyV2! - - """ - The lowest variant's price. - """ - minVariantPrice: MoneyV2! -} - -""" -An auto-generated type for paginating through multiple ProductPriceRanges. -""" -type ProductPriceRangeConnection { - """ - A list of edges. - """ - edges: [ProductPriceRangeEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one ProductPriceRange and a cursor during pagination. -""" -type ProductPriceRangeEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of ProductPriceRangeEdge. - """ - node: ProductPriceRange! -} - -""" -The set of valid sort keys for the Product query. -""" -enum ProductSortKeys { - """ - Sort by the `title` value. - """ - TITLE - - """ - Sort by the `product_type` value. - """ - PRODUCT_TYPE - - """ - Sort by the `vendor` value. """ - VENDOR - - """ - Sort by the `updated_at` value. - """ - UPDATED_AT - - """ - Sort by the `created_at` value. - """ - CREATED_AT - - """ - Sort by the `best_selling` value. - """ - BEST_SELLING - - """ - Sort by the `price` value. - """ - PRICE - - """ - Sort by the `id` value. - """ - ID - - """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. - """ - RELEVANCE -} - -""" -A product variant represents a different version of a product, such as differing sizes or differing colors. -""" -type ProductVariant implements Node & HasMetafields { - """ - Indicates if the product variant is in stock. - """ - available: Boolean @deprecated(reason: "Use `availableForSale` instead") - - """ - Indicates if the product variant is available for sale. - """ - availableForSale: Boolean! - - """ - The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPrice` is higher than `price`. - """ - compareAtPrice: Money @deprecated(reason: "Use `compareAtPriceV2` instead") - - """ - The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPriceV2` is higher than `priceV2`. - """ - compareAtPriceV2: MoneyV2 - - """ - Whether a product is out of stock but still available for purchase (used for backorders). - """ - currentlyNotInStock: Boolean! - - """ - Globally unique identifier. - """ - id: ID! - - """ - Image associated with the product variant. This field falls back to the product image if no image is available. - """ - image( - """ - Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead. - """ - maxWidth: Int - - """ - Image height in pixels between 1 and 2048. This argument is deprecated: Use `maxHeight` on `Image.transformedSrc` instead. - """ - maxHeight: Int - - """ - Crops the image according to the specified region. This argument is deprecated: Use `crop` on `Image.transformedSrc` instead. - """ - crop: CropRegion - - """ - Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead. - """ - scale: Int = 1 - ): Image - - """ - The metafield associated with the resource. - """ - metafield( - """ - Container for a set of metafields (maximum of 20 characters). - """ - namespace: String! - - """ - Identifier for the metafield (maximum of 30 characters). - """ - key: String! - ): Metafield - - """ - A paginated list of metafields associated with the resource. - """ - metafields( - """ - Container for a set of metafields (maximum of 20 characters). - """ - namespace: String - - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): MetafieldConnection! - - """ - List of prices and compare-at prices in the presentment currencies for this shop. - """ - presentmentPrices( - """ - The presentment currencies prices should return in. - """ - presentmentCurrencies: [CurrencyCode!] - - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): ProductVariantPricePairConnection! - - """ - List of unit prices in the presentment currencies for this shop. - """ - presentmentUnitPrices( - """ - Specify the currencies in which to return presentment unit prices. - """ - presentmentCurrencies: [CurrencyCode!] - - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - ): MoneyV2Connection! - - """ - The product variant’s price. + Look up a category by ID or slug. """ - price: Money! @deprecated(reason: "Use `priceV2` instead") - - """ - The product variant’s price. - """ - priceV2: MoneyV2! - - """ - The product object that the product variant belongs to. - """ - product: Product! - - """ - The total sellable quantity of the variant for online sales channels. - """ - quantityAvailable: Int - - """ - Whether a customer needs to provide a shipping address when placing an order for the product variant. - """ - requiresShipping: Boolean! - - """ - List of product options applied to the variant. - """ - selectedOptions: [SelectedOption!]! - - """ - The SKU (stock keeping unit) associated with the variant. - """ - sku: String - - """ - The product variant’s title. - """ - title: String! - - """ - The unit price value for the variant based on the variant's measurement. - """ - unitPrice: MoneyV2 - - """ - The unit price measurement for the variant. - """ - unitPriceMeasurement: UnitPriceMeasurement - - """ - The weight of the product variant in the unit system specified with `weight_unit`. - """ - weight: Float - - """ - Unit of measurement for weight. - """ - weightUnit: WeightUnit! -} - -""" -An auto-generated type for paginating through multiple ProductVariants. -""" -type ProductVariantConnection { - """ - A list of edges. - """ - edges: [ProductVariantEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one ProductVariant and a cursor during pagination. -""" -type ProductVariantEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of ProductVariantEdge. - """ - node: ProductVariant! -} - -""" -The compare-at price and price of a variant sharing a currency. -""" -type ProductVariantPricePair { - """ - The compare-at price of the variant with associated currency. - """ - compareAtPrice: MoneyV2 - - """ - The price of the variant with associated currency. - """ - price: MoneyV2! -} - -""" -An auto-generated type for paginating through multiple ProductVariantPricePairs. -""" -type ProductVariantPricePairConnection { - """ - A list of edges. - """ - edges: [ProductVariantPricePairEdge!]! - - """ - Information to aid in pagination. - """ - pageInfo: PageInfo! -} - -""" -An auto-generated type which holds one ProductVariantPricePair and a cursor during pagination. -""" -type ProductVariantPricePairEdge { - """ - A cursor for use in pagination. - """ - cursor: String! - - """ - The item at the end of ProductVariantPricePairEdge. - """ - node: ProductVariantPricePair! -} - -""" -The set of valid sort keys for the ProductVariant query. -""" -enum ProductVariantSortKeys { - """ - Sort by the `title` value. - """ - TITLE - - """ - Sort by the `sku` value. - """ - SKU - - """ - Sort by the `position` value. - """ - POSITION - - """ - Sort by the `id` value. - """ - ID - - """ - During a search (i.e. when the `query` parameter has been specified on the connection) this sorts the - results by relevance to the search term(s). When no search query is specified, this sort key is not - deterministic and should not be used. - """ - RELEVANCE -} - -""" -The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. -""" -type QueryRoot { - """ - List of the shop's articles. - """ - articles( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - + category( """ - Returns the elements that come before the specified cursor. + ID of the category. """ - before: String + id: ID """ - Reverse the order of the underlying list. + Slug of the category """ - reverse: Boolean = false - - """ - Sort the underlying list by the given key. - """ - sortKey: ArticleSortKeys = ID - - """ - Supported filter parameters: - - `author` - - `blog_title` - - `created_at` - - `tag` - - `updated_at` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String - ): ArticleConnection! + slug: String + ): Category """ - Find a blog by its handle. + Look up a collection by ID. """ - blogByHandle( - """ - The handle of the blog. - """ - handle: String! - ): Blog - - """ - List of the shop's blogs. - """ - blogs( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - + collection( """ - Returns the elements that come after the specified cursor. + ID of the collection. """ - after: String + id: ID """ - Returns up to the last `n` elements from the list. + Slug of the category """ - last: Int + slug: String """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - - """ - Sort the underlying list by the given key. - """ - sortKey: BlogSortKeys = ID - - """ - Supported filter parameters: - - `created_at` - - `handle` - - `title` - - `updated_at` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String - ): BlogConnection! - - """ - Find a collection by its handle. - """ - collectionByHandle( - """ - The handle of the collection. + Slug of a channel for which the data should be returned. """ - handle: String! + channel: String ): Collection """ - List of the shop’s collections. + List of the shop's collections. """ collections( """ - Returns up to the first `n` elements from the list. + Filtering options for collections. """ - first: Int + filter: CollectionFilterInput """ - Returns the elements that come after the specified cursor. + Sort collections. """ - after: String + sortBy: CollectionSortingInput """ - Returns up to the last `n` elements from the list. + Slug of a channel for which the data should be returned. """ - last: Int + channel: String """ - Returns the elements that come before the specified cursor. + Return the elements in the list that come before the specified cursor. """ before: String """ - Reverse the order of the underlying list. + Return the elements in the list that come after the specified cursor. """ - reverse: Boolean = false + after: String """ - Sort the underlying list by the given key. + Return the first n elements from the list. """ - sortKey: CollectionSortKeys = ID + first: Int """ - Supported filter parameters: - - `collection_type` - - `title` - - `updated_at` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. + Return the last n elements from the list. """ - query: String - ): CollectionConnection! + last: Int + ): CollectionCountableConnection """ - Find a customer by its access token. + Look up a product by ID. """ - customer( + product( """ - The customer access token. + ID of the product. """ - customerAccessToken: String! - ): Customer - node( + id: ID + """ - The ID of the Node to return. + Slug of the product. + """ + slug: String + + """ + Slug of a channel for which the data should be returned. + """ + channel: String + ): Product + + """ + List of the shop's products. + """ + products( + """ + Filtering options for products. + """ + filter: ProductFilterInput + + """ + Sort products. + """ + sortBy: ProductOrder + + """ + [Deprecated] Filter products by stock availability. Use the `filter` field instead. This field will be removed after 2020-07-31. + """ + stockAvailability: StockAvailability + + """ + Slug of a channel for which the data should be returned. + """ + channel: String + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): ProductCountableConnection + + """ + Look up a product type by ID. + """ + productType( + """ + ID of the product type. """ id: ID! - ): Node - nodes( - """ - The IDs of the Nodes to return. - """ - ids: [ID!]! - ): [Node]! + ): ProductType """ - Find a page by its handle. + List of the shop's product types. """ - pageByHandle( + productTypes( """ - The handle of the page. + Filtering options for product types. """ - handle: String! + filter: ProductTypeFilterInput + + """ + Sort product types. + """ + sortBy: ProductTypeSortingInput + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): ProductTypeCountableConnection + + """ + Look up a product variant by ID or SKU. + """ + productVariant( + """ + ID of the product variant. + """ + id: ID + + """ + Sku of the product variant. + """ + sku: String + + """ + Slug of a channel for which the data should be returned. + """ + channel: String + ): ProductVariant + + """ + List of product variants. + """ + productVariants( + """ + Filter product variants by given IDs. + """ + ids: [ID] + + """ + Slug of a channel for which the data should be returned. + """ + channel: String + + """ + Filtering options for product variant. + """ + filter: ProductVariantFilterInput + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): ProductVariantCountableConnection + + """ + List of top selling products. + """ + reportProductSales( + """ + Span of time. + """ + period: ReportingPeriod! + + """ + Slug of a channel for which the data should be returned. + """ + channel: String! + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): ProductVariantCountableConnection + + """ + Look up a payment by ID. + """ + payment( + """ + ID of the payment. + """ + id: ID! + ): Payment + + """ + List of payments. + """ + payments( + """ + Filtering options for payments. + """ + filter: PaymentFilterInput + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): PaymentCountableConnection + + """ + Look up a page by ID or slug. + """ + page( + """ + ID of the page. + """ + id: ID + + """ + The slug of the page. + """ + slug: String ): Page """ @@ -8617,1015 +615,19770 @@ type QueryRoot { """ pages( """ - Returns up to the first `n` elements from the list. + Sort pages. """ - first: Int + sortBy: PageSortingInput """ - Returns the elements that come after the specified cursor. + Filtering options for pages. """ - after: String + filter: PageFilterInput """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. + Return the elements in the list that come before the specified cursor. """ before: String """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - - """ - Sort the underlying list by the given key. - """ - sortKey: PageSortKeys = ID - - """ - Supported filter parameters: - - `created_at` - - `handle` - - `title` - - `updated_at` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String - ): PageConnection! - - """ - Find a product by its handle. - """ - productByHandle( - """ - The handle of the product. - """ - handle: String! - ): Product - - """ - Find recommended products related to a given `product_id`. - To learn more about how recommendations are generated, see - [*Showing product recommendations on product pages*](https://help.shopify.com/themes/development/recommended-products). - """ - productRecommendations( - """ - The id of the product. - """ - productId: ID! - ): [Product!] - - """ - Tags added to products. - Additional access scope required: unauthenticated_read_product_tags. - """ - productTags( - """ - Returns up to the first `n` elements from the list. - """ - first: Int! - ): StringConnection! - - """ - List of product types for the shop's products that are published to your app. - """ - productTypes( - """ - Returns up to the first `n` elements from the list. - """ - first: Int! - ): StringConnection! - - """ - List of the shop’s products. - """ - products( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. + Return the elements in the list that come after the specified cursor. """ after: String """ - Returns up to the last `n` elements from the list. + Return the first n elements from the list. """ - last: Int + first: Int """ - Returns the elements that come before the specified cursor. + Return the last n elements from the list. + """ + last: Int + ): PageCountableConnection + + """ + Look up a page type by ID. + """ + pageType( + """ + ID of the page type. + """ + id: ID! + ): PageType + + """ + List of the page types. + """ + pageTypes( + """ + Sort page types. + """ + sortBy: PageTypeSortingInput + + """ + Filtering options for page types. + """ + filter: PageTypeFilterInput + + """ + Return the elements in the list that come before the specified cursor. """ before: String """ - Reverse the order of the underlying list. + Return the elements in the list that come after the specified cursor. """ - reverse: Boolean = false + after: String """ - Sort the underlying list by the given key. + Return the first n elements from the list. """ - sortKey: ProductSortKeys = ID + first: Int """ - Supported filter parameters: - - `available_for_sale` - - `created_at` - - `product_type` - - `tag` - - `title` - - `updated_at` - - `variants.price` - - `vendor` + Return the last n elements from the list. + """ + last: Int + ): PageTypeCountableConnection - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. + """ + List of activity events to display on homepage (at the moment it only contains order-events). + """ + homepageEvents( + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): OrderEventCountableConnection + + """ + Look up an order by ID. + """ + order( + """ + ID of an order. + """ + id: ID! + ): Order + + """ + List of orders. + """ + orders( + """ + Sort orders. + """ + sortBy: OrderSortingInput + + """ + Filtering options for orders. + """ + filter: OrderFilterInput + + """ + [Deprecated] Filter orders from a selected timespan. Use the `filter` field instead. This field will be removed after 2020-07-31. + """ + created: ReportingPeriod + + """ + [Deprecated] Filter order by status. Use the `filter` field instead. This field will be removed after 2020-07-31. + """ + status: OrderStatusFilter + + """ + Slug of a channel for which the data should be returned. + """ + channel: String + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): OrderCountableConnection + + """ + List of draft orders. + """ + draftOrders( + """ + Sort draft orders. + """ + sortBy: OrderSortingInput + + """ + Filtering options for draft orders. + """ + filter: OrderDraftFilterInput + + """ + [Deprecated] Filter draft orders from a selected timespan. Use the `filter` field instead. This field will be removed after 2020-07-31. + """ + created: ReportingPeriod + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): OrderCountableConnection + + """ + Return the total sales amount from a specific period. + """ + ordersTotal( + """ + A period of time. + """ + period: ReportingPeriod + + """ + Slug of a channel for which the data should be returned. + """ + channel: String + ): TaxedMoney + + """ + Look up an order by token. + """ + orderByToken( + """ + The order's token. + """ + token: UUID! + ): Order + + """ + Look up a navigation menu by ID or name. + """ + menu( + """ + Slug of a channel for which the data should be returned. + """ + channel: String + + """ + ID of the menu. + """ + id: ID + + """ + The menu's name. + """ + name: String + + """ + The menu's slug. + """ + slug: String + ): Menu + + """ + List of the storefront's menus. + """ + menus( + """ + Slug of a channel for which the data should be returned. + """ + channel: String + + """ + Sort menus. + """ + sortBy: MenuSortingInput + + """ + Filtering options for menus. + """ + filter: MenuFilterInput + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): MenuCountableConnection + + """ + Look up a menu item by ID. + """ + menuItem( + """ + ID of the menu item. + """ + id: ID! + + """ + Slug of a channel for which the data should be returned. + """ + channel: String + ): MenuItem + + """ + List of the storefronts's menu items. + """ + menuItems( + """ + Slug of a channel for which the data should be returned. + """ + channel: String + + """ + Sort menus items. + """ + sortBy: MenuItemSortingInput + + """ + Filtering options for menu items. + """ + filter: MenuItemFilterInput + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): MenuItemCountableConnection + + """ + Look up a gift card by ID. + """ + giftCard( + """ + ID of the gift card. + """ + id: ID! + ): GiftCard + + """ + List of gift cards. + """ + giftCards( + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): GiftCardCountableConnection + + """ + Look up a plugin by ID. + """ + plugin( + """ + ID of the plugin. + """ + id: ID! + ): Plugin + + """ + List of plugins. + """ + plugins( + """ + Filtering options for plugins. + """ + filter: PluginFilterInput + + """ + Sort plugins. + """ + sortBy: PluginSortingInput + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): PluginCountableConnection + + """ + Look up a sale by ID. + """ + sale( + """ + ID of the sale. + """ + id: ID! + + """ + Slug of a channel for which the data should be returned. + """ + channel: String + ): Sale + + """ + List of the shop's sales. + """ + sales( + """ + Filtering options for sales. + """ + filter: SaleFilterInput + + """ + Sort sales. + """ + sortBy: SaleSortingInput + + """ + Search sales by name, value or type. """ query: String - ): ProductConnection! + + """ + Slug of a channel for which the data should be returned. + """ + channel: String + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): SaleCountableConnection """ - The list of public Storefront API versions, including supported, release candidate and unstable versions. + Look up a voucher by ID. """ - publicApiVersions: [ApiVersion!]! + voucher( + """ + ID of the voucher. + """ + id: ID! + + """ + Slug of a channel for which the data should be returned. + """ + channel: String + ): Voucher """ - The shop associated with the storefront access token. + List of the shop's vouchers. """ - shop: Shop! + vouchers( + """ + Filtering options for vouchers. + """ + filter: VoucherFilterInput + + """ + Sort voucher. + """ + sortBy: VoucherSortingInput + + """ + Search vouchers by name or code. + """ + query: String + + """ + Slug of a channel for which the data should be returned. + """ + channel: String + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): VoucherCountableConnection + + """ + Look up a export file by ID. + """ + exportFile( + """ + ID of the export file job. + """ + id: ID! + ): ExportFile + + """ + List of export files. + """ + exportFiles( + """ + Filtering options for export files. + """ + filter: ExportFileFilterInput + + """ + Sort export files. + """ + sortBy: ExportFileSortingInput + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): ExportFileCountableConnection + + """ + List of all tax rates available from tax gateway. + """ + taxTypes: [TaxType] + + """ + Look up a checkout by token and slug of channel. + """ + checkout( + """ + The checkout's token. + """ + token: UUID + ): Checkout + + """ + List of checkouts. + """ + checkouts( + """ + Slug of a channel for which the data should be returned. + """ + channel: String + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): CheckoutCountableConnection + + """ + Look up a checkout line by ID. + """ + checkoutLine( + """ + ID of the checkout line. + """ + id: ID + ): CheckoutLine + + """ + List of checkout lines. + """ + checkoutLines( + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): CheckoutLineCountableConnection + + """ + Look up a channel by ID. + """ + channel( + """ + ID of the channel. + """ + id: ID + ): Channel + + """ + List of all channels. + """ + channels: [Channel!] + + """ + List of the shop's attributes. + """ + attributes( + """ + Filtering options for attributes. + """ + filter: AttributeFilterInput + + """ + Sorting options for attributes. + """ + sortBy: AttributeSortingInput + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): AttributeCountableConnection + + """ + Look up an attribute by ID. + """ + attribute( + """ + ID of the attribute. + """ + id: ID + + """ + Slug of the attribute. + """ + slug: String + ): Attribute + + """ + List of all apps installations + """ + appsInstallations: [AppInstallation!]! + + """ + List of the apps. + """ + apps( + """ + Filtering options for apps. + """ + filter: AppFilterInput + + """ + Sort apps. + """ + sortBy: AppSortingInput + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): AppCountableConnection + + """ + Look up an app by ID. If ID is not provided, return the currently authenticated app. + """ + app( + """ + ID of the app. + """ + id: ID + ): App + + """ + Returns address validation rules. + """ + addressValidationRules( + """ + Two-letter ISO 3166-1 country code. + """ + countryCode: CountryCode! + + """ + Designation of a region, province or state. + """ + countryArea: String + + """ + City or a town name. + """ + city: String + + """ + Sublocality like a district. + """ + cityArea: String + ): AddressValidationData + + """ + Look up an address by ID. + """ + address( + """ + ID of an address. + """ + id: ID! + ): Address + + """ + List of the shop's customers. + """ + customers( + """ + Filtering options for customers. + """ + filter: CustomerFilterInput + + """ + Sort customers. + """ + sortBy: UserSortingInput + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): UserCountableConnection + + """ + List of permission groups. + """ + permissionGroups( + """ + Filtering options for permission groups. + """ + filter: PermissionGroupFilterInput + + """ + Sort permission groups. + """ + sortBy: PermissionGroupSortingInput + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): GroupCountableConnection + + """ + Look up permission group by ID. + """ + permissionGroup( + """ + ID of the group. + """ + id: ID! + ): Group + + """ + Return the currently authenticated user. + """ + me: User + + """ + List of the shop's staff users. + """ + staffUsers( + """ + Filtering options for staff users. + """ + filter: StaffUserInput + + """ + Sort staff users. + """ + sortBy: UserSortingInput + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): UserCountableConnection + + """ + Look up a user by ID or email address. + """ + user( + """ + ID of the user. + """ + id: ID + + """ + Email address of the user. + """ + email: String + ): User + _entities(representations: [_Any]): [_Entity] + _service: _Service } """ -SEO information. +Webhook. """ -type SEO { - """ - The meta description. - """ - description: String - - """ - The SEO title. - """ - title: String -} - -""" -Script discount applications capture the intentions of a discount that -was created by a Shopify Script. -""" -type ScriptDiscountApplication implements DiscountApplication { - """ - The method by which the discount's value is allocated to its entitled items. - """ - allocationMethod: DiscountApplicationAllocationMethod! - - """ - The description of the application as defined by the Script. - """ - description: String! @deprecated(reason: "Use `title` instead") - - """ - Which lines of targetType that the discount is allocated over. - """ - targetSelection: DiscountApplicationTargetSelection! - - """ - The type of line that the discount is applicable towards. - """ - targetType: DiscountApplicationTargetType! - - """ - The title of the application as defined by the Script. - """ - title: String! - - """ - The value of the discount application. - """ - value: PricingValue! -} - -""" -Properties used by customers to select a product variant. -Products can have multiple options, like different sizes or colors. -""" -type SelectedOption { - """ - The product option’s name. - """ +type Webhook implements Node { name: String! + targetUrl: String! + isActive: Boolean! + secretKey: String """ - The product option’s value. - """ - value: String! -} - -""" -Specifies the input fields required for a selected option. -""" -input SelectedOptionInput { - """ - The product option’s name. - """ - name: String! - - """ - The product option’s value. - """ - value: String! -} - -""" -A shipping rate to be applied to a checkout. -""" -type ShippingRate { - """ - Human-readable unique identifier for this shipping rate. - """ - handle: String! - - """ - Price of this shipping rate. - """ - price: Money! @deprecated(reason: "Use `priceV2` instead") - - """ - Price of this shipping rate. - """ - priceV2: MoneyV2! - - """ - Title of this shipping rate. - """ - title: String! -} - -""" -Shop represents a collection of the general settings and information about the shop. -""" -type Shop { - """ - List of the shop' articles. - """ - articles( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - - """ - Sort the underlying list by the given key. - """ - sortKey: ArticleSortKeys = ID - - """ - Supported filter parameters: - - `author` - - `blog_title` - - `created_at` - - `tag` - - `updated_at` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String - ): ArticleConnection! @deprecated(reason: "Use `QueryRoot.articles` instead.") - - """ - List of the shop' blogs. - """ - blogs( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - - """ - Sort the underlying list by the given key. - """ - sortKey: BlogSortKeys = ID - - """ - Supported filter parameters: - - `created_at` - - `handle` - - `title` - - `updated_at` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String - ): BlogConnection! @deprecated(reason: "Use `QueryRoot.blogs` instead.") - - """ - Find a collection by its handle. - """ - collectionByHandle( - """ - The handle of the collection. - """ - handle: String! - ): Collection - @deprecated(reason: "Use `QueryRoot.collectionByHandle` instead.") - - """ - List of the shop’s collections. - """ - collections( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - - """ - Sort the underlying list by the given key. - """ - sortKey: CollectionSortKeys = ID - - """ - Supported filter parameters: - - `collection_type` - - `title` - - `updated_at` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String - ): CollectionConnection! - @deprecated(reason: "Use `QueryRoot.collections` instead.") - - """ - The three-letter code for the currency that the shop accepts. - """ - currencyCode: CurrencyCode! - @deprecated(reason: "Use `paymentSettings` instead") - - """ - A description of the shop. - """ - description: String - - """ - A string representing the way currency is formatted when the currency isn’t specified. - """ - moneyFormat: String! - - """ - The shop’s name. - """ - name: String! - - """ - Settings related to payments. - """ - paymentSettings: PaymentSettings! - - """ - The shop’s primary domain. - """ - primaryDomain: Domain! - - """ - The shop’s privacy policy. - """ - privacyPolicy: ShopPolicy - - """ - Find a product by its handle. - """ - productByHandle( - """ - The handle of the product. - """ - handle: String! - ): Product @deprecated(reason: "Use `QueryRoot.productByHandle` instead.") - - """ - A list of tags that have been added to products. - Additional access scope required: unauthenticated_read_product_tags. - """ - productTags( - """ - Returns up to the first `n` elements from the list. - """ - first: Int! - ): StringConnection! - @deprecated(reason: "Use `QueryRoot.productTags` instead.") - - """ - List of the shop’s product types. - """ - productTypes( - """ - Returns up to the first `n` elements from the list. - """ - first: Int! - ): StringConnection! - @deprecated(reason: "Use `QueryRoot.productTypes` instead.") - - """ - List of the shop’s products. - """ - products( - """ - Returns up to the first `n` elements from the list. - """ - first: Int - - """ - Returns the elements that come after the specified cursor. - """ - after: String - - """ - Returns up to the last `n` elements from the list. - """ - last: Int - - """ - Returns the elements that come before the specified cursor. - """ - before: String - - """ - Reverse the order of the underlying list. - """ - reverse: Boolean = false - - """ - Sort the underlying list by the given key. - """ - sortKey: ProductSortKeys = ID - - """ - Supported filter parameters: - - `available_for_sale` - - `created_at` - - `product_type` - - `tag` - - `title` - - `updated_at` - - `variants.price` - - `vendor` - - See the detailed [search syntax](https://help.shopify.com/api/getting-started/search-syntax) - for more information about using filters. - """ - query: String - ): ProductConnection! @deprecated(reason: "Use `QueryRoot.products` instead.") - - """ - The shop’s refund policy. - """ - refundPolicy: ShopPolicy - - """ - The shop’s shipping policy. - """ - shippingPolicy: ShopPolicy - - """ - Countries that the shop ships to. - """ - shipsToCountries: [CountryCode!]! - - """ - The shop’s Shopify Payments account id. - """ - shopifyPaymentsAccountId: String - @deprecated(reason: "Use `paymentSettings` instead") - - """ - The shop’s terms of service. - """ - termsOfService: ShopPolicy -} - -""" -Policy that a merchant has configured for their store, such as their refund or privacy policy. -""" -type ShopPolicy implements Node { - """ - Policy text, maximum size of 64kb. - """ - body: String! - - """ - Policy’s handle. - """ - handle: String! - - """ - Globally unique identifier. + The ID of the object. """ id: ID! """ - Policy’s title. + List of webhook events. """ - title: String! - - """ - Public URL to the policy. - """ - url: URL! + events: [WebhookEvent!]! + app: App! } """ -An auto-generated type for paginating through multiple Strings. +An object with an ID """ -type StringConnection { +interface Node { """ - A list of edges. + The ID of the object. """ - edges: [StringEdge!]! + id: ID! +} + +""" +Webhook event. +""" +type WebhookEvent { + """ + Internal name of the event type. + """ + eventType: WebhookEventTypeEnum! """ - Information to aid in pagination. + Display name of the event. + """ + name: String! +} + +""" +Enum determining type of webhook. +""" +enum WebhookEventTypeEnum { + """ + All the events. + """ + ANY_EVENTS + + """ + A new order is placed. + """ + ORDER_CREATED + + """ + An order is confirmed (status change unconfirmed -> unfulfilled) by staff user using OrderConfirm mutation. Also triggers when user finish checkout and shop setting `automatically_confirm_all_new_orders` is enabled. + """ + ORDER_CONFIRMED + + """ + Payment is made and an order is fully paid. + """ + ORDER_FULLY_PAID + + """ + An order is updated; triggered for all changes related to an order; covers all other order webhooks, except for ORDER_CREATED. + """ + ORDER_UPDATED + + """ + An order is cancelled. + """ + ORDER_CANCELLED + + """ + An order is fulfilled. + """ + ORDER_FULFILLED + + """ + An invoice for order requested. + """ + INVOICE_REQUESTED + + """ + An invoice is deleted. + """ + INVOICE_DELETED + + """ + Invoice has been sent. + """ + INVOICE_SENT + + """ + A new customer account is created. + """ + CUSTOMER_CREATED + + """ + A customer account is updated. + """ + CUSTOMER_UPDATED + + """ + A new product is created. + """ + PRODUCT_CREATED + + """ + A product is updated. + """ + PRODUCT_UPDATED + + """ + A product is deleted. + """ + PRODUCT_DELETED + + """ + A new product variant is created. + """ + PRODUCT_VARIANT_CREATED + + """ + A product variant is updated. + """ + PRODUCT_VARIANT_UPDATED + + """ + A product variant is deleted. + """ + PRODUCT_VARIANT_DELETED + + """ + A new checkout is created. + """ + CHECKOUT_CREATED + + """ + A checkout is updated. Also triggers for all updates related to a checkout. + """ + CHECKOUT_UPDATED + + """ + A new fulfillment is created. + """ + FULFILLMENT_CREATED + + """ + User notification triggered. + """ + NOTIFY_USER + + """ + A new page is created. + """ + PAGE_CREATED + + """ + A page is updated. + """ + PAGE_UPDATED + + """ + A page is deleted. + """ + PAGE_DELETED +} + +""" +Represents app data. +""" +type App implements Node & ObjectWithMetadata { + """ + The ID of the object. + """ + id: ID! + + """ + Name of the app. + """ + name: String + + """ + The date and time when the app was created. + """ + created: DateTime + + """ + Determine if app will be set active or not. + """ + isActive: Boolean + + """ + List of the app's permissions. + """ + permissions: [Permission] + + """ + Last 4 characters of the tokens. + """ + tokens: [AppToken] + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! + + """ + Type of the app. + """ + type: AppTypeEnum + + """ + List of webhooks assigned to this app. + """ + webhooks: [Webhook] + + """ + Description of this app. + """ + aboutApp: String + + """ + Description of the data privacy defined for this app. + """ + dataPrivacy: String + + """ + Url to details about the privacy policy on the app owner page. + """ + dataPrivacyUrl: String + + """ + Homepage of the app. + """ + homepageUrl: String + + """ + Support page for the app. + """ + supportUrl: String + + """ + Url to iframe with the configuration for the app. + """ + configurationUrl: String + + """ + Url to iframe with the app. + """ + appUrl: String + + """ + Version number of the app. + """ + version: String + + """ + JWT token used to authenticate by thridparty app. + """ + accessToken: String +} + +interface ObjectWithMetadata { + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! +} + +type MetadataItem { + """ + Key of a metadata item. + """ + key: String! + + """ + Value of a metadata item. + """ + value: String! +} + +""" +The `DateTime` scalar type represents a DateTime +value as specified by +[iso8601](https://en.wikipedia.org/wiki/ISO_8601). +""" +scalar DateTime + +""" +Represents a permission object in a friendly form. +""" +type Permission { + """ + Internal code for permission. + """ + code: PermissionEnum! + + """ + Describe action(s) allowed to do by permission. + """ + name: String! +} + +""" +An enumeration. +""" +enum PermissionEnum { + MANAGE_USERS + MANAGE_STAFF + MANAGE_APPS + MANAGE_CHANNELS + MANAGE_DISCOUNTS + MANAGE_PLUGINS + MANAGE_GIFT_CARD + MANAGE_MENUS + MANAGE_ORDERS + MANAGE_PAGES + MANAGE_PAGE_TYPES_AND_ATTRIBUTES + MANAGE_PRODUCTS + MANAGE_PRODUCT_TYPES_AND_ATTRIBUTES + MANAGE_SHIPPING + MANAGE_SETTINGS + MANAGE_TRANSLATIONS + MANAGE_CHECKOUTS +} + +""" +Represents token data. +""" +type AppToken implements Node { + """ + Name of the authenticated token. + """ + name: String + + """ + Last 4 characters of the token. + """ + authToken: String + + """ + The ID of the object. + """ + id: ID! +} + +""" +Enum determining type of your App. +""" +enum AppTypeEnum { + """ + Local Saleor App. The app is fully manageable from dashboard. You can change assigned permissions, add webhooks, or authentication token + """ + LOCAL + + """ + Third party external App. Installation is fully automated. Saleor uses a defined App manifest to gather all required information. + """ + THIRDPARTY +} + +""" +Allows use of a JSON String for input / output from the GraphQL schema. + +Use of this type is *not recommended* as you lose the benefits of having a defined, static +schema (one of the key benefits of GraphQL). +""" +scalar JSONString + +""" +An enumeration. +""" +enum WebhookSampleEventTypeEnum { + ORDER_CREATED + ORDER_CONFIRMED + ORDER_FULLY_PAID + ORDER_UPDATED + ORDER_CANCELLED + ORDER_FULFILLED + INVOICE_REQUESTED + INVOICE_DELETED + INVOICE_SENT + CUSTOMER_CREATED + CUSTOMER_UPDATED + PRODUCT_CREATED + PRODUCT_UPDATED + PRODUCT_DELETED + PRODUCT_VARIANT_CREATED + PRODUCT_VARIANT_UPDATED + PRODUCT_VARIANT_DELETED + CHECKOUT_CREATED + CHECKOUT_UPDATED + FULFILLMENT_CREATED + NOTIFY_USER + PAGE_CREATED + PAGE_UPDATED + PAGE_DELETED +} + +""" +Represents warehouse. +""" +type Warehouse implements Node & ObjectWithMetadata { + """ + The ID of the object. + """ + id: ID! + name: String! + slug: String! + companyName: String! + shippingZones( + before: String + after: String + first: Int + last: Int + ): ShippingZoneCountableConnection! + address: Address! + email: String! + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! +} + +type ShippingZoneCountableConnection { + """ + Pagination data for this connection. """ pageInfo: PageInfo! + edges: [ShippingZoneCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int } """ -An auto-generated type which holds one String and a cursor during pagination. +The Relay compliant `PageInfo` type, containing data necessary to paginate this connection. """ -type StringEdge { +type PageInfo { + """ + When paginating forwards, are there more items? + """ + hasNextPage: Boolean! + + """ + When paginating backwards, are there more items? + """ + hasPreviousPage: Boolean! + + """ + When paginating backwards, the cursor to continue. + """ + startCursor: String + + """ + When paginating forwards, the cursor to continue. + """ + endCursor: String +} + +type ShippingZoneCountableEdge { + """ + The item at the end of the edge. + """ + node: ShippingZone! + """ A cursor for use in pagination. """ cursor: String! - - """ - The item at the end of StringEdge. - """ - node: String! } """ -Specifies the fields required to complete a checkout with -a tokenized payment. +Represents a shipping zone in the shop. Zones are the concept used only for grouping shipping methods in the dashboard, and are never exposed to the customers directly. """ -input TokenizedPaymentInput { +type ShippingZone implements Node & ObjectWithMetadata { """ - The amount of the payment. + The ID of the object. """ - amount: Money! + id: ID! + name: String! + default: Boolean! """ - A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. + List of private metadata items.Requires proper staff permissions to access. """ - idempotencyKey: String! + privateMetadata: [MetadataItem]! """ - The billing address for the payment. + List of public metadata items. Can be accessed without permissions. """ - billingAddress: MailingAddressInput! + metadata: [MetadataItem]! """ - The type of payment token. + Lowest and highest prices for the shipping. """ - type: String! + priceRange: MoneyRange """ - A simple string or JSON containing the required payment data for the tokenized payment. + List of countries available for the method. """ - paymentData: String! + countries: [CountryDisplay] """ - Executes the payment in test mode if possible. Defaults to `false`. + List of shipping methods available for orders shipped to countries within this shipping zone. """ - test: Boolean + shippingMethods: [ShippingMethod] """ - Public Hash Key used for AndroidPay payments only. + List of warehouses for shipping zone. """ - identifier: String + warehouses: [Warehouse!]! + + """ + List of channels for shipping zone. + """ + channels: [Channel!]! + + """ + Description of a shipping zone. + """ + description: String } """ -Specifies the fields required to complete a checkout with -a tokenized payment. +Represents a range of amounts of money. """ -input TokenizedPaymentInputV2 { +type MoneyRange { """ - The amount and currency of the payment. + Lower bound of a price range. """ - paymentAmount: MoneyInput! + start: Money """ - A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. + Upper bound of a price range. """ - idempotencyKey: String! - - """ - The billing address for the payment. - """ - billingAddress: MailingAddressInput! - - """ - A simple string or JSON containing the required payment data for the tokenized payment. - """ - paymentData: String! - - """ - Whether to execute the payment in test mode, if possible. Test mode is not supported in production stores. Defaults to `false`. - """ - test: Boolean - - """ - Public Hash Key used for AndroidPay payments only. - """ - identifier: String - - """ - The type of payment token. - """ - type: String! + stop: Money } """ -Specifies the fields required to complete a checkout with -a tokenized payment. +Represents amount of money in specific currency. """ -input TokenizedPaymentInputV3 { +type Money { """ - The amount and currency of the payment. + Currency code. """ - paymentAmount: MoneyInput! + currency: String! """ - A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. + Amount of money. """ - idempotencyKey: String! + amount: Float! """ - The billing address for the payment. + Money formatted according to the current locale. """ - billingAddress: MailingAddressInput! + localized: String! + @deprecated( + reason: "Price formatting according to the current locale should be handled by the frontend client. This field will be removed after 2020-07-31." + ) +} + +type CountryDisplay { + """ + Country code. + """ + code: String! """ - A simple string or JSON containing the required payment data for the tokenized payment. + Country name. """ - paymentData: String! + country: String! """ - Whether to execute the payment in test mode, if possible. Test mode is not supported in production stores. Defaults to `false`. + Country tax. """ - test: Boolean - - """ - Public Hash Key used for AndroidPay payments only. - """ - identifier: String - - """ - The type of payment token. - """ - type: PaymentTokenType! + vat: VAT } """ -An object representing exchange of money for a product or service. +Represents a VAT rate for a country. """ -type Transaction { +type VAT { """ - The amount of money that the transaction was for. + Country code. """ - amount: Money! @deprecated(reason: "Use `amountV2` instead") + countryCode: String! """ - The amount of money that the transaction was for. + Standard VAT rate in percent. """ - amountV2: MoneyV2! + standardRate: Float """ - The kind of the transaction. + Country's VAT rate exceptions for specific types of goods. """ - kind: TransactionKind! - - """ - The status of the transaction. - """ - status: TransactionStatus! @deprecated(reason: "Use `statusV2` instead") - - """ - The status of the transaction. - """ - statusV2: TransactionStatus - - """ - Whether the transaction was done in test mode or not. - """ - test: Boolean! + reducedRates: [ReducedRate]! } -enum TransactionKind { +""" +Represents a reduced VAT rate for a particular type of goods. +""" +type ReducedRate { + """ + Reduced VAT rate in percent. + """ + rate: Float! + + """ + A type of goods. + """ + rateType: TaxRateType! +} + +""" +An enumeration. +""" +enum TaxRateType { + ACCOMMODATION + ADMISSION_TO_CULTURAL_EVENTS + ADMISSION_TO_ENTERTAINMENT_EVENTS + ADMISSION_TO_SPORTING_EVENTS + ADVERTISING + AGRICULTURAL_SUPPLIES + BABY_FOODSTUFFS + BIKES + BOOKS + CHILDRENS_CLOTHING + DOMESTIC_FUEL + DOMESTIC_SERVICES + E_BOOKS + FOODSTUFFS + HOTELS + MEDICAL + NEWSPAPERS + PASSENGER_TRANSPORT + PHARMACEUTICALS + PROPERTY_RENOVATIONS + RESTAURANTS + SOCIAL_HOUSING + STANDARD + WATER + WINE +} + +""" +Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers. +""" +type ShippingMethod implements Node & ObjectWithMetadata { + """ + The ID of the object. + """ + id: ID! + name: String! + minimumOrderWeight: Weight + maximumOrderWeight: Weight + maximumDeliveryDays: Int + minimumDeliveryDays: Int + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! + + """ + Type of the shipping method. + """ + type: ShippingMethodTypeEnum + + """ + Returns translated shipping method fields for the given language code. + """ + translation( + """ + A language code to return the translation for shipping method. + """ + languageCode: LanguageCodeEnum! + ): ShippingMethodTranslation + + """ + List of channels available for the method. + """ + channelListings: [ShippingMethodChannelListing!] + + """ + The price of the cheapest variant (including discounts). + """ + price: Money + + """ + The price of the cheapest variant (including discounts). + """ + maximumOrderPrice: Money + + """ + The price of the cheapest variant (including discounts). + """ + minimumOrderPrice: Money + + """ + Postal code ranges rule of exclusion or inclusion of the shipping method. + """ + postalCodeRules: [ShippingMethodPostalCodeRule] + + """ + List of excluded products for the shipping method. + """ + excludedProducts( + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): ProductCountableConnection +} + +""" +Represents weight value in a specific weight unit. +""" +type Weight { + """ + Weight unit. + """ + unit: WeightUnitsEnum! + + """ + Weight value. + """ + value: Float! +} + +""" +An enumeration. +""" +enum WeightUnitsEnum { + KG + LB + OZ + G +} + +""" +An enumeration. +""" +enum ShippingMethodTypeEnum { + PRICE + WEIGHT +} + +type ShippingMethodTranslation implements Node { + """ + The ID of the object. + """ + id: ID! + name: String + + """ + Translation language. + """ + language: LanguageDisplay! +} + +type LanguageDisplay { + """ + ISO 639 representation of the language name. + """ + code: LanguageCodeEnum! + + """ + Full name of the language. + """ + language: String! +} + +""" +An enumeration. +""" +enum LanguageCodeEnum { + AR + AZ + BG + BN + CA + CS + DA + DE + EL + EN + ES + ES_CO + ET + FA + FI + FR + HI + HU + HY + ID + IS + IT + JA + KA + KM + KO + LT + MN + MY + NB + NL + PL + PT + PT_BR + RO + RU + SK + SL + SQ + SR + SV + SW + TA + TH + TR + UK + VI + ZH_HANS + ZH_HANT +} + +""" +Represents shipping method channel listing. +""" +type ShippingMethodChannelListing implements Node { + """ + The ID of the object. + """ + id: ID! + channel: Channel! + minimumOrderPrice: Money + maximumOrderPrice: Money + price: Money +} + +""" +Represents channel. +""" +type Channel implements Node { + """ + The ID of the object. + """ + id: ID! + name: String! + isActive: Boolean! + slug: String! + currencyCode: String! + + """ + Whether a channel has associated orders. + """ + hasOrders: Boolean! + + """ + List of channel shipping zones. + """ + shippingZones: [ShippingZone!]! +} + +""" +Represents shipping method postal code rule. +""" +type ShippingMethodPostalCodeRule implements Node { + """ + Start address range. + """ + start: String + + """ + End address range. + """ + end: String + + """ + Inclusion type of the postal code rule. + """ + inclusionType: PostalCodeRuleInclusionTypeEnum + + """ + The ID of the object. + """ + id: ID! +} + +""" +An enumeration. +""" +enum PostalCodeRuleInclusionTypeEnum { + INCLUDE + EXCLUDE +} + +type ProductCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [ProductCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type ProductCountableEdge { + """ + The item at the end of the edge. + """ + node: Product! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +""" +Represents an individual item for sale in the storefront. +""" +type Product implements Node & ObjectWithMetadata { + """ + The ID of the object. + """ + id: ID! + seoTitle: String + seoDescription: String + name: String! + description: JSONString + productType: ProductType! + slug: String! + category: Category + updatedAt: DateTime + chargeTaxes: Boolean! + weight: Weight + defaultVariant: ProductVariant + rating: Float + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! + + """ + Description of the product (JSON). + """ + descriptionJson: JSONString + @deprecated( + reason: "Will be removed in Saleor 4.0. Use the `description` field instead." + ) + + """ + The storefront URL for the product. + """ + url: String! + @deprecated(reason: "This field will be removed after 2020-07-31.") + + """ + The main thumbnail for a product. + """ + thumbnail( + """ + Size of thumbnail. + """ + size: Int + ): Image + + """ + Lists the storefront product's pricing, the current price and discounts, only meant for displaying. + """ + pricing( + """ + Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration. + """ + address: AddressInput + ): ProductPricingInfo + + """ + Whether the product is in stock and visible or not. + """ + isAvailable( + """ + Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration. + """ + address: AddressInput + ): Boolean + + """ + A type of tax. Assigned by enabled tax gateway + """ + taxType: TaxType + + """ + List of attributes assigned to this product. + """ + attributes: [SelectedAttribute!]! + + """ + List of availability in channels for the product. + """ + channelListings: [ProductChannelListing!] + + """ + Get a single product media by ID. + """ + mediaById( + """ + ID of a product media. + """ + id: ID + ): ProductMedia! + + """ + Get a single product image by ID. + """ + imageById( + """ + ID of a product image. + """ + id: ID + ): ProductImage + @deprecated( + reason: "Will be removed in Saleor 4.0. Use the `mediaById` field instead." + ) + + """ + List of variants for the product. + """ + variants: [ProductVariant] + + """ + List of media for the product. + """ + media: [ProductMedia!] + + """ + List of images for the product. + """ + images: [ProductImage] + @deprecated( + reason: "Will be removed in Saleor 4.0. Use the `media` field instead." + ) + + """ + List of collections for the product. + """ + collections: [Collection] + + """ + Returns translated product fields for the given language code. + """ + translation( + """ + A language code to return the translation for product. + """ + languageCode: LanguageCodeEnum! + ): ProductTranslation + + """ + Date when product is available for purchase. + """ + availableForPurchase: Date + + """ + Whether the product is available for purchase. + """ + isAvailableForPurchase: Boolean +} + +""" +Represents a type of product. It defines what attributes are available to products of this type. +""" +type ProductType implements Node & ObjectWithMetadata { + """ + The ID of the object. + """ + id: ID! + name: String! + slug: String! + hasVariants: Boolean! + isShippingRequired: Boolean! + isDigital: Boolean! + weight: Weight + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! + + """ + List of products of this type. + """ + products( + """ + Slug of a channel for which the data should be returned. + """ + channel: String + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): ProductCountableConnection + @deprecated( + reason: "Use the top-level `products` query with the `productTypes` filter." + ) + + """ + A type of tax. Assigned by enabled tax gateway + """ + taxType: TaxType + + """ + Variant attributes of that product type. + """ + variantAttributes( + """ + Define scope of returned attributes. + """ + variantSelection: VariantAttributeScope + ): [Attribute] + + """ + Product attributes of that product type. + """ + productAttributes: [Attribute] + availableAttributes( + filter: AttributeFilterInput + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): AttributeCountableConnection +} + +""" +Representation of tax types fetched from tax gateway. +""" +type TaxType { + """ + Description of the tax type. + """ + description: String + + """ + External tax code used to identify given tax group. + """ + taxCode: String +} + +""" +Custom attribute of a product. Attributes can be assigned to products and variants at the product type level. +""" +type Attribute implements Node & ObjectWithMetadata { + """ + The ID of the object. + """ + id: ID! + productTypes( + before: String + after: String + first: Int + last: Int + ): ProductTypeCountableConnection! + productVariantTypes( + before: String + after: String + first: Int + last: Int + ): ProductTypeCountableConnection! + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! + + """ + The input type to use for entering attribute values in the dashboard. + """ + inputType: AttributeInputTypeEnum + + """ + The entity type which can be used as a reference. + """ + entityType: AttributeEntityTypeEnum + + """ + Name of an attribute displayed in the interface. + """ + name: String + + """ + Internal representation of an attribute name. + """ + slug: String + + """ + The attribute type. + """ + type: AttributeTypeEnum + + """ + List of attribute's values. + """ + values: [AttributeValue] + + """ + Whether the attribute requires values to be passed or not. + """ + valueRequired: Boolean! + + """ + Whether the attribute should be visible or not in storefront. + """ + visibleInStorefront: Boolean! + + """ + Whether the attribute can be filtered in storefront. + """ + filterableInStorefront: Boolean! + + """ + Whether the attribute can be filtered in dashboard. + """ + filterableInDashboard: Boolean! + + """ + Whether the attribute can be displayed in the admin product list. + """ + availableInGrid: Boolean! + + """ + Returns translated attribute fields for the given language code. + """ + translation( + """ + A language code to return the translation for attribute. + """ + languageCode: LanguageCodeEnum! + ): AttributeTranslation + + """ + The position of the attribute in the storefront navigation (0 by default). + """ + storefrontSearchPosition: Int! +} + +type ProductTypeCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [ProductTypeCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type ProductTypeCountableEdge { + """ + The item at the end of the edge. + """ + node: ProductType! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +""" +An enumeration. +""" +enum AttributeInputTypeEnum { + DROPDOWN + MULTISELECT + FILE + REFERENCE + RICH_TEXT +} + +""" +An enumeration. +""" +enum AttributeEntityTypeEnum { + PAGE + PRODUCT +} + +""" +An enumeration. +""" +enum AttributeTypeEnum { + PRODUCT_TYPE + PAGE_TYPE +} + +""" +Represents a value of an attribute. +""" +type AttributeValue implements Node { + """ + The ID of the object. + """ + id: ID! + + """ + Name of a value displayed in the interface. + """ + name: String + + """ + Internal representation of a value (unique per attribute). + """ + slug: String + + """ + Represents the value of the attribute value. + """ + value: String + + """ + Returns translated attribute value fields for the given language code. + """ + translation( + """ + A language code to return the translation for attribute value. + """ + languageCode: LanguageCodeEnum! + ): AttributeValueTranslation + + """ + The input type to use for entering attribute values in the dashboard. + """ + inputType: AttributeInputTypeEnum + + """ + The ID of the attribute reference. + """ + reference: ID + + """ + Represents file URL and content type (if attribute value is a file). + """ + file: File + + """ + Represents the text (JSON) of the attribute value. + """ + richText: JSONString +} + +type AttributeValueTranslation implements Node { + """ + The ID of the object. + """ + id: ID! + name: String! + richText: JSONString + + """ + Translation language. + """ + language: LanguageDisplay! +} + +type File { + """ + The URL of the file. + """ + url: String! + + """ + Content type of the file. + """ + contentType: String +} + +type AttributeTranslation implements Node { + """ + The ID of the object. + """ + id: ID! + name: String! + + """ + Translation language. + """ + language: LanguageDisplay! +} + +enum VariantAttributeScope { + ALL + VARIANT_SELECTION + NOT_VARIANT_SELECTION +} + +type AttributeCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [AttributeCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type AttributeCountableEdge { + """ + The item at the end of the edge. + """ + node: Attribute! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input AttributeFilterInput { + valueRequired: Boolean + isVariantOnly: Boolean + visibleInStorefront: Boolean + filterableInStorefront: Boolean + filterableInDashboard: Boolean + availableInGrid: Boolean + metadata: [MetadataInput] + search: String + ids: [ID] + type: AttributeTypeEnum + inCollection: ID + inCategory: ID + + """ + Specifies the channel by which the data should be sorted. + """ + channel: String +} + +input MetadataInput { + """ + Key of a metadata item. + """ + key: String! + + """ + Value of a metadata item. + """ + value: String! +} + +""" +Represents a single category of products. Categories allow to organize products in a tree-hierarchies which can be used for navigation in the storefront. +""" +type Category implements Node & ObjectWithMetadata { + seoTitle: String + seoDescription: String + + """ + The ID of the object. + """ + id: ID! + name: String! + description: JSONString + slug: String! + parent: Category + level: Int! + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! + + """ + Description of the category (JSON). + """ + descriptionJson: JSONString + @deprecated( + reason: "Will be removed in Saleor 4.0. Use the `description` field instead." + ) + + """ + List of ancestors of the category. + """ + ancestors( + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): CategoryCountableConnection + + """ + List of products in the category. + """ + products( + """ + Slug of a channel for which the data should be returned. + """ + channel: String + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): ProductCountableConnection + + """ + The storefront's URL for the category. + """ + url: String + @deprecated(reason: "This field will be removed after 2020-07-31.") + + """ + List of children of the category. + """ + children( + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): CategoryCountableConnection + backgroundImage( + """ + Size of the image. + """ + size: Int + ): Image + + """ + Returns translated category fields for the given language code. + """ + translation( + """ + A language code to return the translation for category. + """ + languageCode: LanguageCodeEnum! + ): CategoryTranslation +} + +type CategoryCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [CategoryCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type CategoryCountableEdge { + """ + The item at the end of the edge. + """ + node: Category! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +""" +Represents an image. +""" +type Image { + """ + The URL of the image. + """ + url: String! + + """ + Alt text for an image. + """ + alt: String +} + +type CategoryTranslation implements Node { + seoTitle: String + seoDescription: String + + """ + The ID of the object. + """ + id: ID! + name: String! + description: JSONString + + """ + Translation language. + """ + language: LanguageDisplay! + + """ + Translated description of the product (JSON). + """ + descriptionJson: JSONString + @deprecated( + reason: "Will be removed in Saleor 4.0. Use the `description` field instead." + ) +} + +""" +Represents a version of a product such as different size or color. +""" +type ProductVariant implements Node & ObjectWithMetadata { + """ + The ID of the object. + """ + id: ID! + name: String! + sku: String! + product: Product! + trackInventory: Boolean! + weight: Weight + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! + + """ + List of price information in channels for the product. + """ + channelListings: [ProductVariantChannelListing!] + + """ + Lists the storefront variant's pricing, the current price and discounts, only meant for displaying. + """ + pricing( + """ + Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration. + """ + address: AddressInput + ): VariantPricingInfo + + """ + List of attributes assigned to this variant. + """ + attributes( + """ + Define scope of returned attributes. + """ + variantSelection: VariantAttributeScope + ): [SelectedAttribute!]! + + """ + Cost price of the variant. + """ + costPrice: Money + + """ + Gross margin percentage value. + """ + margin: Int + + """ + Total quantity ordered. + """ + quantityOrdered: Int + + """ + Total revenue generated by a variant in given period of time. Note: this field should be queried using `reportProductSales` query as it uses optimizations suitable for such calculations. + """ + revenue(period: ReportingPeriod): TaxedMoney + + """ + List of images for the product variant. + """ + images: [ProductImage] + @deprecated( + reason: "Will be removed in Saleor 4.0. Use the `media` instead." + ) + + """ + List of media for the product variant. + """ + media: [ProductMedia!] + + """ + Returns translated product variant fields for the given language code. + """ + translation( + """ + A language code to return the translation for product variant. + """ + languageCode: LanguageCodeEnum! + ): ProductVariantTranslation + + """ + Digital content for the product variant. + """ + digitalContent: DigitalContent + + """ + Stocks for the product variant. + """ + stocks( + """ + Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration. + """ + address: AddressInput + + """ + DEPRECATED: use `address` argument instead. This argument will be removed in Saleor 4.0. Two-letter ISO 3166-1 country code. + """ + countryCode: CountryCode + ): [Stock] + + """ + Quantity of a product available for sale in one checkout. + """ + quantityAvailable( + """ + Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration. + """ + address: AddressInput + + """ + DEPRECATED: use `address` argument instead. This argument will be removed in Saleor 4.0.Two-letter ISO 3166-1 country code. When provided, the exact quantity from a warehouse operating in shipping zones that contain this country will be returned. Otherwise, it will return the maximum quantity from all shipping zones. + """ + countryCode: CountryCode + ): Int! +} + +""" +Represents product varaint channel listing. +""" +type ProductVariantChannelListing implements Node { + """ + The ID of the object. + """ + id: ID! + channel: Channel! + price: Money + + """ + Cost price of the variant. + """ + costPrice: Money + + """ + Gross margin percentage value. + """ + margin: Int +} + +""" +Represents availability of a variant in the storefront. +""" +type VariantPricingInfo { + """ + Whether it is in sale or not. + """ + onSale: Boolean + + """ + The discount amount if in sale (null otherwise). + """ + discount: TaxedMoney + + """ + The discount amount in the local currency. + """ + discountLocalCurrency: TaxedMoney + + """ + The price, with any discount subtracted. + """ + price: TaxedMoney + + """ + The price without any discount. + """ + priceUndiscounted: TaxedMoney + + """ + The discounted price in the local currency. + """ + priceLocalCurrency: TaxedMoney +} + +""" +Represents a monetary value with taxes. In cases where taxes were not applied, net and gross values will be equal. +""" +type TaxedMoney { + """ + Currency code. + """ + currency: String! + + """ + Amount of money including taxes. + """ + gross: Money! + + """ + Amount of money without taxes. + """ + net: Money! + + """ + Amount of taxes. + """ + tax: Money! +} + +input AddressInput { + """ + Given name. + """ + firstName: String + + """ + Family name. + """ + lastName: String + + """ + Company or organization. + """ + companyName: String + + """ + Address. + """ + streetAddress1: String + + """ + Address. + """ + streetAddress2: String + + """ + City. + """ + city: String + + """ + District. + """ + cityArea: String + + """ + Postal code. + """ + postalCode: String + + """ + Country. + """ + country: CountryCode + + """ + State or province. + """ + countryArea: String + + """ + Phone number. + """ + phone: String +} + +""" +An enumeration. +""" +enum CountryCode { + AF + AX + AL + DZ + AS + AD + AO + AI + AQ + AG + AR + AM + AW + AU + AT + AZ + BS + BH + BD + BB + BY + BE + BZ + BJ + BM + BT + BO + BQ + BA + BW + BV + BR + IO + BN + BG + BF + BI + CV + KH + CM + CA + KY + CF + TD + CL + CN + CX + CC + CO + KM + CG + CD + CK + CR + CI + HR + CU + CW + CY + CZ + DK + DJ + DM + DO + EC + EG + SV + GQ + ER + EE + SZ + ET + EU + FK + FO + FJ + FI + FR + GF + PF + TF + GA + GM + GE + DE + GH + GI + GR + GL + GD + GP + GU + GT + GG + GN + GW + GY + HT + HM + VA + HN + HK + HU + IS + IN + ID + IR + IQ + IE + IM + IL + IT + JM + JP + JE + JO + KZ + KE + KI + KW + KG + LA + LV + LB + LS + LR + LY + LI + LT + LU + MO + MG + MW + MY + MV + ML + MT + MH + MQ + MR + MU + YT + MX + FM + MD + MC + MN + ME + MS + MA + MZ + MM + NA + NR + NP + NL + NC + NZ + NI + NE + NG + NU + NF + KP + MK + MP + NO + OM + PK + PW + PS + PA + PG + PY + PE + PH + PN + PL + PT + PR + QA + RE + RO + RU + RW + BL + SH + KN + LC + MF + PM + VC + WS + SM + ST + SA + SN + RS + SC + SL + SG + SX + SK + SI + SB + SO + ZA + GS + KR + SS + ES + LK + SD + SR + SJ + SE + CH + SY + TW + TJ + TZ + TH + TL + TG + TK + TO + TT + TN + TR + TM + TC + TV + UG + UA + AE + GB + UM + US + UY + UZ + VU + VE + VN + VG + VI + WF + EH + YE + ZM + ZW +} + +""" +Represents a custom attribute. +""" +type SelectedAttribute { + """ + Name of an attribute displayed in the interface. + """ + attribute: Attribute! + + """ + Values of an attribute. + """ + values: [AttributeValue]! +} + +enum ReportingPeriod { + TODAY + THIS_MONTH +} + +""" +Represents a product image. +""" +type ProductImage { + """ + The ID of the image. + """ + id: ID! + + """ + The alt text of the image. + """ + alt: String + + """ + The new relative sorting position of the item (from -inf to +inf). 1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged. + """ + sortOrder: Int + + """ + The URL of the image. + """ + url( + """ + Size of the image. + """ + size: Int + ): String! +} + +""" +Represents a product media. +""" +type ProductMedia implements Node { + """ + The ID of the object. + """ + id: ID! + sortOrder: Int + alt: String! + type: ProductMediaType! + oembedData: JSONString! + + """ + The URL of the media. + """ + url( + """ + Size of the image. + """ + size: Int + ): String! +} + +""" +An enumeration. +""" +enum ProductMediaType { + """ + An uploaded image or an URL to an image + """ + IMAGE + + """ + A URL to an external video + """ + VIDEO +} + +type ProductVariantTranslation implements Node { + """ + The ID of the object. + """ + id: ID! + name: String! + + """ + Translation language. + """ + language: LanguageDisplay! +} + +type DigitalContent implements Node & ObjectWithMetadata { + useDefaultSettings: Boolean! + automaticFulfillment: Boolean! + contentFile: String! + maxDownloads: Int + urlValidDays: Int + + """ + List of URLs for the digital variant. + """ + urls: [DigitalContentUrl] + + """ + The ID of the object. + """ + id: ID! + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! + + """ + Product variant assigned to digital content. + """ + productVariant: ProductVariant! +} + +type DigitalContentUrl implements Node { + content: DigitalContent! + created: DateTime! + downloadNum: Int! + + """ + The ID of the object. + """ + id: ID! + + """ + URL for digital content. + """ + url: String + + """ + UUID of digital content. + """ + token: UUID! +} + +scalar UUID + +""" +Represents stock. +""" +type Stock implements Node { + warehouse: Warehouse! + productVariant: ProductVariant! + + """ + Quantity of a product in the warehouse's possession, including the allocated stock that is waiting for shipment. + """ + quantity: Int! + + """ + The ID of the object. + """ + id: ID! + + """ + Quantity allocated for orders + """ + quantityAllocated: Int! +} + +""" +Represents availability of a product in the storefront. +""" +type ProductPricingInfo { + """ + Whether it is in sale or not. + """ + onSale: Boolean + + """ + The discount amount if in sale (null otherwise). + """ + discount: TaxedMoney + + """ + The discount amount in the local currency. + """ + discountLocalCurrency: TaxedMoney + + """ + The discounted price range of the product variants. + """ + priceRange: TaxedMoneyRange + + """ + The undiscounted price range of the product variants. + """ + priceRangeUndiscounted: TaxedMoneyRange + + """ + The discounted price range of the product variants in the local currency. + """ + priceRangeLocalCurrency: TaxedMoneyRange +} + +""" +Represents a range of monetary values. +""" +type TaxedMoneyRange { + """ + Lower bound of a price range. + """ + start: TaxedMoney + + """ + Upper bound of a price range. + """ + stop: TaxedMoney +} + +""" +Represents product channel listing. +""" +type ProductChannelListing implements Node { + """ + The ID of the object. + """ + id: ID! + publicationDate: Date + isPublished: Boolean! + channel: Channel! + visibleInListings: Boolean! + availableForPurchase: Date + + """ + The price of the cheapest variant (including discounts). + """ + discountedPrice: Money + + """ + Purchase cost of product. + """ + purchaseCost: MoneyRange + + """ + Range of margin percentage value. + """ + margin: Margin + + """ + Whether the product is available for purchase. + """ + isAvailableForPurchase: Boolean + + """ + Lists the storefront product's pricing, the current price and discounts, only meant for displaying. + """ + pricing( + """ + Destination address used to find warehouses where stock availability for this product is checked. If address is empty, uses `Shop.companyAddress` or fallbacks to server's `settings.DEFAULT_COUNTRY` configuration. + """ + address: AddressInput + ): ProductPricingInfo +} + +""" +The `Date` scalar type represents a Date +value as specified by +[iso8601](https://en.wikipedia.org/wiki/ISO_8601). +""" +scalar Date + +type Margin { + start: Int + stop: Int +} + +""" +Represents a collection of products. +""" +type Collection implements Node & ObjectWithMetadata { + seoTitle: String + seoDescription: String + + """ + The ID of the object. + """ + id: ID! + name: String! + description: JSONString + slug: String! + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! + + """ + Description of the collection (JSON). + """ + descriptionJson: JSONString + @deprecated( + reason: "Will be removed in Saleor 4.0. Use the `description` field instead." + ) + + """ + List of products in this collection. + """ + products( + """ + Filtering options for products. + """ + filter: ProductFilterInput + + """ + Sort products. + """ + sortBy: ProductOrder + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): ProductCountableConnection + backgroundImage( + """ + Size of the image. + """ + size: Int + ): Image + + """ + Returns translated collection fields for the given language code. + """ + translation( + """ + A language code to return the translation for collection. + """ + languageCode: LanguageCodeEnum! + ): CollectionTranslation + + """ + List of channels in which the collection is available. + """ + channelListings: [CollectionChannelListing!] +} + +input ProductFilterInput { + isPublished: Boolean + collections: [ID] + categories: [ID] + hasCategory: Boolean + attributes: [AttributeInput] + stockAvailability: StockAvailability + productType: ID + stocks: ProductStockFilterInput + search: String + metadata: [MetadataInput] + price: PriceRangeInput + minimalPrice: PriceRangeInput + productTypes: [ID] + ids: [ID] + + """ + Specifies the channel by which the data should be sorted. + """ + channel: String +} + +input AttributeInput { + """ + Internal representation of an attribute name. + """ + slug: String! + + """ + [Deprecated] Internal representation of a value (unique per attribute). This field will be removed after 2020-07-31. + """ + value: String + + """ + Internal representation of a value (unique per attribute). + """ + values: [String] +} + +enum StockAvailability { + IN_STOCK + OUT_OF_STOCK +} + +input ProductStockFilterInput { + warehouseIds: [ID!] + quantity: IntRangeInput +} + +input IntRangeInput { + """ + Value greater than or equal to. + """ + gte: Int + + """ + Value less than or equal to. + """ + lte: Int +} + +input PriceRangeInput { + """ + Price greater than or equal to. + """ + gte: Float + + """ + Price less than or equal to. + """ + lte: Float +} + +input ProductOrder { + """ + Specifies the direction in which to sort products. + """ + direction: OrderDirection! + + """ + Specifies the channel in which to sort the data. + """ + channel: String + + """ + Sort product by the selected attribute's values. + Note: this doesn't take translations into account yet. + """ + attributeId: ID + + """ + Sort products by the selected field. + """ + field: ProductOrderField +} + +enum OrderDirection { + """ + Specifies an ascending sort order. + """ + ASC + + """ + Specifies a descending sort order. + """ + DESC +} + +enum ProductOrderField { + """ + Sort products by name. + """ + NAME + + """ + Sort products by rank. Note: This option is available only with the `search` filter. + """ + RANK + + """ + Sort products by price. + """ + PRICE + + """ + Sort products by a minimal price of a product's variant. + """ + MINIMAL_PRICE + + """ + Sort products by update date. + """ + DATE + + """ + Sort products by type. + """ + TYPE + + """ + Sort products by publication status. + """ + PUBLISHED + + """ + Sort products by publication date. + """ + PUBLICATION_DATE + + """ + Sort products by collection. Note: This option is available only for the `Collection.products` query. + """ + COLLECTION + + """ + Sort products by rating. + """ + RATING +} + +type CollectionTranslation implements Node { + seoTitle: String + seoDescription: String + + """ + The ID of the object. + """ + id: ID! + name: String! + description: JSONString + + """ + Translation language. + """ + language: LanguageDisplay! + + """ + Translated description of the product (JSON). + """ + descriptionJson: JSONString + @deprecated( + reason: "Will be removed in Saleor 4.0. Use the `description` field instead." + ) +} + +""" +Represents collection channel listing. +""" +type CollectionChannelListing implements Node { + publicationDate: Date + isPublished: Boolean! + + """ + The ID of the object. + """ + id: ID! + channel: Channel! +} + +type ProductTranslation implements Node { + """ + The ID of the object. + """ + id: ID! + seoTitle: String + seoDescription: String + name: String! + description: JSONString + + """ + Translation language. + """ + language: LanguageDisplay! + + """ + Translated description of the product (JSON). + """ + descriptionJson: JSONString + @deprecated( + reason: "Will be removed in Saleor 4.0. Use the `description` field instead." + ) +} + +""" +Represents user address data. +""" +type Address implements Node { + """ + The ID of the object. + """ + id: ID! + firstName: String! + lastName: String! + companyName: String! + streetAddress1: String! + streetAddress2: String! + city: String! + cityArea: String! + postalCode: String! + + """ + Shop's default country. + """ + country: CountryDisplay! + countryArea: String! + phone: String + + """ + Address is user's default shipping address. + """ + isDefaultShippingAddress: Boolean + + """ + Address is user's default billing address. + """ + isDefaultBillingAddress: Boolean +} + +type WarehouseCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [WarehouseCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type WarehouseCountableEdge { + """ + The item at the end of the edge. + """ + node: Warehouse! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input WarehouseFilterInput { + search: String + ids: [ID] +} + +input WarehouseSortingInput { + """ + Specifies the direction in which to sort products. + """ + direction: OrderDirection! + + """ + Sort warehouses by the selected field. + """ + field: WarehouseSortField! +} + +enum WarehouseSortField { + """ + Sort warehouses by name. + """ + NAME +} + +type TranslatableItemConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [TranslatableItemEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type TranslatableItemEdge { + """ + The item at the end of the edge. + """ + node: TranslatableItem! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +union TranslatableItem = + ProductTranslatableContent + | CollectionTranslatableContent + | CategoryTranslatableContent + | AttributeTranslatableContent + | AttributeValueTranslatableContent + | ProductVariantTranslatableContent + | PageTranslatableContent + | ShippingMethodTranslatableContent + | SaleTranslatableContent + | VoucherTranslatableContent + | MenuItemTranslatableContent + +type ProductTranslatableContent implements Node { + """ + The ID of the object. + """ + id: ID! + seoTitle: String + seoDescription: String + name: String! + description: JSONString + + """ + Description of the product (JSON). + """ + descriptionJson: JSONString + @deprecated( + reason: "Will be removed in Saleor 4.0. Use the `description` field instead." + ) + + """ + Returns translated product fields for the given language code. + """ + translation( + """ + A language code to return the translation for product. + """ + languageCode: LanguageCodeEnum! + ): ProductTranslation + + """ + Represents an individual item for sale in the storefront. + """ + product: Product +} + +type CollectionTranslatableContent implements Node { + seoTitle: String + seoDescription: String + + """ + The ID of the object. + """ + id: ID! + name: String! + description: JSONString + + """ + Description of the collection (JSON). + """ + descriptionJson: JSONString + @deprecated( + reason: "Will be removed in Saleor 4.0. Use the `description` field instead." + ) + + """ + Returns translated collection fields for the given language code. + """ + translation( + """ + A language code to return the translation for collection. + """ + languageCode: LanguageCodeEnum! + ): CollectionTranslation + + """ + Represents a collection of products. + """ + collection: Collection +} + +type CategoryTranslatableContent implements Node { + seoTitle: String + seoDescription: String + + """ + The ID of the object. + """ + id: ID! + name: String! + description: JSONString + + """ + Description of the category (JSON). + """ + descriptionJson: JSONString + @deprecated( + reason: "Will be removed in Saleor 4.0. Use the `description` field instead." + ) + + """ + Returns translated category fields for the given language code. + """ + translation( + """ + A language code to return the translation for category. + """ + languageCode: LanguageCodeEnum! + ): CategoryTranslation + + """ + Represents a single category of products. + """ + category: Category +} + +type AttributeTranslatableContent implements Node { + """ + The ID of the object. + """ + id: ID! + name: String! + + """ + Returns translated attribute fields for the given language code. + """ + translation( + """ + A language code to return the translation for attribute. + """ + languageCode: LanguageCodeEnum! + ): AttributeTranslation + + """ + Custom attribute of a product. + """ + attribute: Attribute +} + +type AttributeValueTranslatableContent implements Node { + """ + The ID of the object. + """ + id: ID! + name: String! + + """ + Returns translated attribute value fields for the given language code. + """ + translation( + """ + A language code to return the translation for attribute value. + """ + languageCode: LanguageCodeEnum! + ): AttributeValueTranslation + + """ + Represents a value of an attribute. + """ + attributeValue: AttributeValue +} + +type ProductVariantTranslatableContent implements Node { + """ + The ID of the object. + """ + id: ID! + name: String! + + """ + Returns translated product variant fields for the given language code. + """ + translation( + """ + A language code to return the translation for product variant. + """ + languageCode: LanguageCodeEnum! + ): ProductVariantTranslation + + """ + Represents a version of a product such as different size or color. + """ + productVariant: ProductVariant +} + +type PageTranslatableContent implements Node { + seoTitle: String + seoDescription: String + + """ + The ID of the object. + """ + id: ID! + title: String! + content: JSONString + + """ + Content of the page (JSON). + """ + contentJson: JSONString + @deprecated( + reason: "Will be removed in Saleor 4.0. Use the `content` field instead." + ) + + """ + Returns translated page fields for the given language code. + """ + translation( + """ + A language code to return the translation for page. + """ + languageCode: LanguageCodeEnum! + ): PageTranslation + + """ + ('A static page that can be manually added by a shop operator ', 'through the dashboard.') + """ + page: Page +} + +type PageTranslation implements Node { + seoTitle: String + seoDescription: String + + """ + The ID of the object. + """ + id: ID! + title: String! + content: JSONString + + """ + Translation language. + """ + language: LanguageDisplay! + + """ + Translated description of the page (JSON). + """ + contentJson: JSONString + @deprecated( + reason: "Will be removed in Saleor 4.0. Use the `content` field instead." + ) +} + +""" +A static page that can be manually added by a shop operator through the dashboard. +""" +type Page implements Node & ObjectWithMetadata { + seoTitle: String + seoDescription: String + + """ + The ID of the object. + """ + id: ID! + title: String! + content: JSONString + publicationDate: Date + isPublished: Boolean! + slug: String! + pageType: PageType! + created: DateTime! + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! + + """ + Content of the page (JSON). + """ + contentJson: JSONString! + @deprecated( + reason: "Will be removed in Saleor 4.0. Use the `content` field instead." + ) + + """ + Returns translated page fields for the given language code. + """ + translation( + """ + A language code to return the translation for page. + """ + languageCode: LanguageCodeEnum! + ): PageTranslation + + """ + List of attributes assigned to this product. + """ + attributes: [SelectedAttribute!]! +} + +""" +Represents a type of page. It defines what attributes are available to pages of this type. +""" +type PageType implements Node & ObjectWithMetadata { + """ + The ID of the object. + """ + id: ID! + name: String! + slug: String! + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! + + """ + Page attributes of that page type. + """ + attributes: [Attribute] + + """ + Attributes that can be assigned to the page type. + """ + availableAttributes( + filter: AttributeFilterInput + + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): AttributeCountableConnection + + """ + Whether page type has pages assigned. + """ + hasPages: Boolean +} + +type ShippingMethodTranslatableContent implements Node { + """ + The ID of the object. + """ + id: ID! + name: String! + + """ + Returns translated shipping method fields for the given language code. + """ + translation( + """ + A language code to return the translation for shipping method. + """ + languageCode: LanguageCodeEnum! + ): ShippingMethodTranslation + + """ + Shipping method are the methods you'll use to get customer's orders to them. They are directly exposed to the customers. + """ + shippingMethod: ShippingMethod +} + +type SaleTranslatableContent implements Node { + """ + The ID of the object. + """ + id: ID! + name: String! + + """ + Returns translated sale fields for the given language code. + """ + translation( + """ + A language code to return the translation for sale. + """ + languageCode: LanguageCodeEnum! + ): SaleTranslation + + """ + Sales allow creating discounts for categories, collections or products and are visible to all the customers. + """ + sale: Sale +} + +type SaleTranslation implements Node { + """ + The ID of the object. + """ + id: ID! + name: String + + """ + Translation language. + """ + language: LanguageDisplay! +} + +""" +Sales allow creating discounts for categories, collections or products and are visible to all the customers. +""" +type Sale implements Node { + """ + The ID of the object. + """ + id: ID! + name: String! + type: SaleType! + startDate: DateTime! + endDate: DateTime + + """ + List of categories this sale applies to. + """ + categories( + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): CategoryCountableConnection + + """ + List of collections this sale applies to. + """ + collections( + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): CollectionCountableConnection + + """ + List of products this sale applies to. + """ + products( + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): ProductCountableConnection + + """ + Returns translated sale fields for the given language code. + """ + translation( + """ + A language code to return the translation for sale. + """ + languageCode: LanguageCodeEnum! + ): SaleTranslation + + """ + List of channels available for the sale. + """ + channelListings: [SaleChannelListing!] + + """ + Sale value. + """ + discountValue: Float + + """ + Currency code for sale. + """ + currency: String +} + +""" +An enumeration. +""" +enum SaleType { + """ + fixed + """ + FIXED + + """ + % + """ + PERCENTAGE +} + +type CollectionCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [CollectionCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type CollectionCountableEdge { + """ + The item at the end of the edge. + """ + node: Collection! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +""" +Represents sale channel listing. +""" +type SaleChannelListing implements Node { + """ + The ID of the object. + """ + id: ID! + channel: Channel! + discountValue: Float! + currency: String! +} + +type VoucherTranslatableContent implements Node { + """ + The ID of the object. + """ + id: ID! + name: String + + """ + Returns translated voucher fields for the given language code. + """ + translation( + """ + A language code to return the translation for voucher. + """ + languageCode: LanguageCodeEnum! + ): VoucherTranslation + + """ + Vouchers allow giving discounts to particular customers on categories, collections or specific products. They can be used during checkout by providing valid voucher codes. + """ + voucher: Voucher +} + +type VoucherTranslation implements Node { + """ + The ID of the object. + """ + id: ID! + name: String + + """ + Translation language. + """ + language: LanguageDisplay! +} + +""" +Vouchers allow giving discounts to particular customers on categories, collections or specific products. They can be used during checkout by providing valid voucher codes. +""" +type Voucher implements Node { + """ + The ID of the object. + """ + id: ID! + name: String + + """ + Determines a type of voucher. + """ + type: VoucherTypeEnum! + code: String! + usageLimit: Int + used: Int! + startDate: DateTime! + endDate: DateTime + applyOncePerOrder: Boolean! + applyOncePerCustomer: Boolean! + + """ + Determines a type of discount for voucher - value or percentage + """ + discountValueType: DiscountValueTypeEnum! + minCheckoutItemsQuantity: Int + + """ + List of categories this voucher applies to. + """ + categories( + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): CategoryCountableConnection + + """ + List of collections this voucher applies to. + """ + collections( + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): CollectionCountableConnection + + """ + List of products this voucher applies to. + """ + products( + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): ProductCountableConnection + + """ + List of countries available for the shipping voucher. + """ + countries: [CountryDisplay] + + """ + Returns translated voucher fields for the given language code. + """ + translation( + """ + A language code to return the translation for voucher. + """ + languageCode: LanguageCodeEnum! + ): VoucherTranslation + + """ + Voucher value. + """ + discountValue: Float + + """ + Currency code for voucher. + """ + currency: String + + """ + Minimum order value to apply voucher. + """ + minSpent: Money + + """ + List of availability in channels for the voucher. + """ + channelListings: [VoucherChannelListing!] +} + +enum VoucherTypeEnum { + SHIPPING + ENTIRE_ORDER + SPECIFIC_PRODUCT +} + +enum DiscountValueTypeEnum { + FIXED + PERCENTAGE +} + +""" +Represents voucher channel listing. +""" +type VoucherChannelListing implements Node { + """ + The ID of the object. + """ + id: ID! + channel: Channel! + discountValue: Float! + currency: String! + minSpent: Money +} + +type MenuItemTranslatableContent implements Node { + """ + The ID of the object. + """ + id: ID! + name: String! + + """ + Returns translated menu item fields for the given language code. + """ + translation( + """ + A language code to return the translation for menu item. + """ + languageCode: LanguageCodeEnum! + ): MenuItemTranslation + + """ + Represents a single item of the related menu. Can store categories, collection or pages. + """ + menuItem: MenuItem +} + +type MenuItemTranslation implements Node { + """ + The ID of the object. + """ + id: ID! + name: String! + + """ + Translation language. + """ + language: LanguageDisplay! +} + +""" +Represents a single item of the related menu. Can store categories, collection or pages. +""" +type MenuItem implements Node & ObjectWithMetadata { + """ + The ID of the object. + """ + id: ID! + name: String! + menu: Menu! + parent: MenuItem + category: Category + collection: Collection + page: Page + level: Int! + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! + children: [MenuItem] + + """ + URL to the menu item. + """ + url: String + + """ + Returns translated menu item fields for the given language code. + """ + translation( + """ + A language code to return the translation for menu item. + """ + languageCode: LanguageCodeEnum! + ): MenuItemTranslation +} + +""" +Represents a single menu - an object that is used to help navigate through the store. +""" +type Menu implements Node & ObjectWithMetadata { + """ + The ID of the object. + """ + id: ID! + name: String! + slug: String! + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! + items: [MenuItem] +} + +enum TranslatableKinds { + ATTRIBUTE + ATTRIBUTE_VALUE + CATEGORY + COLLECTION + MENU_ITEM + PAGE + PRODUCT SALE - CAPTURE - AUTHORIZATION - EMV_AUTHORIZATION - CHANGE + SHIPPING_METHOD + VARIANT + VOUCHER } -enum TransactionStatus { +type StockCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [StockCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type StockCountableEdge { + """ + The item at the end of the edge. + """ + node: Stock! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input StockFilterInput { + quantity: Float + search: String +} + +""" +Represents a shop resource containing general shop data and configuration. +""" +type Shop { + """ + List of available payment gateways. + """ + availablePaymentGateways( + """ + A currency for which gateways will be returned. + """ + currency: String + ): [PaymentGateway!]! + + """ + List of available external authentications. + """ + availableExternalAuthentications: [ExternalAuthentication!]! + + """ + Shipping methods that are available for the shop. + """ + availableShippingMethods( + """ + Slug of a channel for which the data should be returned. + """ + channel: String! + + """ + Address for which available shipping methods should be returned. + """ + address: AddressInput + ): [ShippingMethod] + + """ + List of countries available in the shop. + """ + countries( + """ + A language code to return the translation for. + """ + languageCode: LanguageCodeEnum + ): [CountryDisplay!]! + + """ + Shop's default country. + """ + defaultCountry: CountryDisplay + + """ + Default shop's email sender's name. + """ + defaultMailSenderName: String + + """ + Default shop's email sender's address. + """ + defaultMailSenderAddress: String + + """ + Shop's description. + """ + description: String + + """ + Shop's domain data. + """ + domain: Domain! + + """ + List of the shops's supported languages. + """ + languages: [LanguageDisplay]! + + """ + Shop's name. + """ + name: String! + + """ + Shop's navigation. + """ + navigation: Navigation + @deprecated( + reason: "Fetch menus using the `menu` query with `slug` parameter." + ) + + """ + List of available permissions. + """ + permissions: [Permission]! + + """ + List of possible phone prefixes. + """ + phonePrefixes: [String]! + + """ + Header text. + """ + headerText: String + + """ + Include taxes in prices. + """ + includeTaxesInPrices: Boolean! + + """ + Display prices with tax in store. + """ + displayGrossPrices: Boolean! + + """ + Charge taxes on shipping. + """ + chargeTaxesOnShipping: Boolean! + + """ + Enable inventory tracking. + """ + trackInventoryByDefault: Boolean + + """ + Default weight unit. + """ + defaultWeightUnit: WeightUnitsEnum + + """ + Returns translated shop fields for the given language code. + """ + translation( + """ + A language code to return the translation for shop. + """ + languageCode: LanguageCodeEnum! + ): ShopTranslation + + """ + Enable automatic fulfillment for all digital products. + """ + automaticFulfillmentDigitalProducts: Boolean + + """ + Default number of max downloads per digital content URL. + """ + defaultDigitalMaxDownloads: Int + + """ + Default number of days which digital content URL will be valid. + """ + defaultDigitalUrlValidDays: Int + + """ + Company address. + """ + companyAddress: Address + + """ + URL of a view where customers can set their password. + """ + customerSetPasswordUrl: String + + """ + List of staff notification recipients. + """ + staffNotificationRecipients: [StaffNotificationRecipient] + + """ + Resource limitations and current usage if any set for a shop + """ + limits: LimitInfo! + + """ + Saleor API version. + """ + version: String! +} + +""" +Available payment gateway backend with configuration necessary to setup client. +""" +type PaymentGateway { + """ + Payment gateway name. + """ + name: String! + + """ + Payment gateway ID. + """ + id: ID! + + """ + Payment gateway client configuration. + """ + config: [GatewayConfigLine!]! + + """ + Payment gateway supported currencies. + """ + currencies: [String]! +} + +""" +Payment gateway client configuration key and value pair. +""" +type GatewayConfigLine { + """ + Gateway config key. + """ + field: String! + + """ + Gateway config value for key. + """ + value: String +} + +type ExternalAuthentication { + """ + ID of external authentication plugin. + """ + id: String! + + """ + Name of external authentication plugin. + """ + name: String +} + +""" +Represents shop's domain. +""" +type Domain { + """ + The host name of the domain. + """ + host: String! + + """ + Inform if SSL is enabled. + """ + sslEnabled: Boolean! + + """ + Shop's absolute URL. + """ + url: String! +} + +""" +Represents shop's navigation menus. +""" +type Navigation { + """ + Main navigation bar. + """ + main: Menu + + """ + Secondary navigation bar. + """ + secondary: Menu +} + +type ShopTranslation implements Node { + """ + The ID of the object. + """ + id: ID! + headerText: String! + description: String! + + """ + Translation language. + """ + language: LanguageDisplay! +} + +""" +Represents a recipient of email notifications send by Saleor, such as notifications about new orders. Notifications can be assigned to staff users or arbitrary email addresses. +""" +type StaffNotificationRecipient implements Node { + """ + Returns a user subscribed to email notifications. + """ + user: User + + """ + Determines if a notification active. + """ + active: Boolean + + """ + The ID of the object. + """ + id: ID! + + """ + Returns email address of a user subscribed to email notifications. + """ + email: String +} + +""" +Represents user data. +""" +type User implements Node & ObjectWithMetadata { + """ + The ID of the object. + """ + id: ID! + lastLogin: DateTime + email: String! + firstName: String! + lastName: String! + isStaff: Boolean! + isActive: Boolean! + + """ + A note about the customer. + """ + note: String + dateJoined: DateTime! + defaultShippingAddress: Address + defaultBillingAddress: Address + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! + + """ + List of all user's addresses. + """ + addresses: [Address] + + """ + Returns the last open checkout of this user. + """ + checkout: Checkout + @deprecated( + reason: "Use the `checkout_tokens` field to fetch the user checkouts." + ) + + """ + Returns the checkout UUID's assigned to this user. + """ + checkoutTokens( + """ + Slug of a channel for which the data should be returned. + """ + channel: String + ): [UUID!] + + """ + List of the user gift cards. + """ + giftCards( + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): GiftCardCountableConnection + + """ + List of user's orders. + """ + orders( + """ + Return the elements in the list that come before the specified cursor. + """ + before: String + + """ + Return the elements in the list that come after the specified cursor. + """ + after: String + + """ + Return the first n elements from the list. + """ + first: Int + + """ + Return the last n elements from the list. + """ + last: Int + ): OrderCountableConnection + + """ + List of user's permissions. + """ + permissions: [Permission] + @deprecated( + reason: "Will be removed in Saleor 2.11.Use the `userPermissions` instead." + ) + + """ + List of user's permissions. + """ + userPermissions: [UserPermission] + + """ + List of user's permission groups. + """ + permissionGroups: [Group] + + """ + List of user's permission groups which user can manage. + """ + editableGroups: [Group] + avatar( + """ + Size of the avatar. + """ + size: Int + ): Image + + """ + List of events associated with the user. + """ + events: [CustomerEvent] + + """ + List of stored payment sources. + """ + storedPaymentSources: [PaymentSource] + + """ + User language code. + """ + languageCode: LanguageCodeEnum! +} + +""" +Checkout object. +""" +type Checkout implements Node & ObjectWithMetadata { + created: DateTime! + lastChange: DateTime! + user: User + quantity: Int! + channel: Channel! + billingAddress: Address + shippingAddress: Address + note: String! + discount: Money + discountName: String + translatedDiscountName: String + voucherCode: String + + """ + List of gift cards associated with this checkout. + """ + giftCards: [GiftCard] + + """ + The ID of the object. + """ + id: ID! + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! + + """ + Shipping methods that can be used with this order. + """ + availableShippingMethods: [ShippingMethod]! + + """ + List of available payment gateways. + """ + availablePaymentGateways: [PaymentGateway!]! + + """ + Email of a customer. + """ + email: String! + + """ + Returns True, if checkout requires shipping. + """ + isShippingRequired: Boolean! + + """ + A list of checkout lines, each containing information about an item in the checkout. + """ + lines: [CheckoutLine] + + """ + The price of the shipping, with all the taxes included. + """ + shippingPrice: TaxedMoney + + """ + The shipping method related with checkout. + """ + shippingMethod: ShippingMethod + + """ + The price of the checkout before shipping, with taxes included. + """ + subtotalPrice: TaxedMoney + + """ + The checkout's token. + """ + token: UUID! + + """ + The sum of the the checkout line prices, with all the taxes,shipping costs, and discounts included. + """ + totalPrice: TaxedMoney + + """ + Checkout language code. + """ + languageCode: LanguageCodeEnum! +} + +""" +A gift card is a prepaid electronic payment card accepted in stores. They can be used during checkout by providing a valid gift card codes. +""" +type GiftCard implements Node { + """ + Gift card code. + """ + code: String + + """ + The customer who bought a gift card. + """ + user: User + created: DateTime! + startDate: Date! + endDate: Date + lastUsedOn: DateTime + isActive: Boolean! + initialBalance: Money + currentBalance: Money + + """ + The ID of the object. + """ + id: ID! + + """ + Code in format which allows displaying in a user interface. + """ + displayCode: String +} + +""" +Represents an item in the checkout. +""" +type CheckoutLine implements Node { + """ + The ID of the object. + """ + id: ID! + variant: ProductVariant! + quantity: Int! + + """ + The sum of the checkout line price, taxes and discounts. + """ + totalPrice: TaxedMoney + + """ + Indicates whether the item need to be delivered. + """ + requiresShipping: Boolean +} + +type GiftCardCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [GiftCardCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type GiftCardCountableEdge { + """ + The item at the end of the edge. + """ + node: GiftCard! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +type OrderCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [OrderCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type OrderCountableEdge { + """ + The item at the end of the edge. + """ + node: Order! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +""" +Represents an order in the shop. +""" +type Order implements Node & ObjectWithMetadata { + """ + The ID of the object. + """ + id: ID! + created: DateTime! + status: OrderStatus! + user: User + trackingClientId: String! + billingAddress: Address + shippingAddress: Address + shippingMethod: ShippingMethod + shippingMethodName: String + channel: Channel! + + """ + Total price of shipping. + """ + shippingPrice: TaxedMoney! + shippingTaxRate: Float! + token: String! + voucher: Voucher + + """ + List of user gift cards. + """ + giftCards: [GiftCard] + displayGrossPrices: Boolean! + customerNote: String! + weight: Weight + redirectUrl: String + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! + + """ + List of shipments for the order. + """ + fulfillments: [Fulfillment]! + + """ + List of order lines. + """ + lines: [OrderLine]! + + """ + List of actions that can be performed in the current state of an order. + """ + actions: [OrderAction]! + + """ + Shipping methods that can be used with this order. + """ + availableShippingMethods: [ShippingMethod] + + """ + List of order invoices. + """ + invoices: [Invoice] + + """ + User-friendly number of an order. + """ + number: String + + """ + Informs if an order is fully paid. + """ + isPaid: Boolean! + + """ + Internal payment status. + """ + paymentStatus: PaymentChargeStatusEnum! + + """ + User-friendly payment status. + """ + paymentStatusDisplay: String! + + """ + List of payments for the order. + """ + payments: [Payment] + + """ + Total amount of the order. + """ + total: TaxedMoney! + + """ + Undiscounted total amount of the order. + """ + undiscountedTotal: TaxedMoney! + + """ + The sum of line prices not including shipping. + """ + subtotal: TaxedMoney! + + """ + User-friendly order status. + """ + statusDisplay: String + + """ + Informs whether a draft order can be finalized(turned into a regular order). + """ + canFinalize: Boolean! + + """ + Amount authorized for the order. + """ + totalAuthorized: Money! + + """ + Amount captured by payment. + """ + totalCaptured: Money! + + """ + List of events associated with the order. + """ + events: [OrderEvent] + + """ + The difference between the paid and the order total amount. + """ + totalBalance: Money! + + """ + Email address of the customer. + """ + userEmail: String + + """ + Returns True, if order requires shipping. + """ + isShippingRequired: Boolean! + languageCode: String! + @deprecated( + reason: "Use the `languageCodeEnum` field to fetch the language code. This field will be removed in Saleor 4.0." + ) + + """ + Order language code. + """ + languageCodeEnum: LanguageCodeEnum! + + """ + Returns applied discount. + """ + discount: Money + @deprecated( + reason: "Use discounts field. This field will be removed in Saleor 4.0." + ) + + """ + Discount name. + """ + discountName: String + @deprecated( + reason: "Use discounts field. This field will be removed in Saleor 4.0." + ) + + """ + Translated discount name. + """ + translatedDiscountName: String + @deprecated( + reason: "Use discounts field. This field will be removed in Saleor 4.0." + ) + + """ + List of all discounts assigned to the order. + """ + discounts: [OrderDiscount!] +} + +""" +An enumeration. +""" +enum OrderStatus { + """ + Draft + """ + DRAFT + + """ + Unconfirmed + """ + UNCONFIRMED + + """ + Unfulfilled + """ + UNFULFILLED + + """ + Partially fulfilled + """ + PARTIALLY_FULFILLED + + """ + Partially returned + """ + PARTIALLY_RETURNED + + """ + Returned + """ + RETURNED + + """ + Fulfilled + """ + FULFILLED + + """ + Canceled + """ + CANCELED +} + +""" +Represents order fulfillment. +""" +type Fulfillment implements Node & ObjectWithMetadata { + """ + The ID of the object. + """ + id: ID! + fulfillmentOrder: Int! + status: FulfillmentStatus! + trackingNumber: String! + created: DateTime! + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! + + """ + List of lines for the fulfillment. + """ + lines: [FulfillmentLine] + + """ + User-friendly fulfillment status. + """ + statusDisplay: String + + """ + Warehouse from fulfillment was fulfilled. + """ + warehouse: Warehouse +} + +""" +An enumeration. +""" +enum FulfillmentStatus { + """ + Fulfilled + """ + FULFILLED + + """ + Refunded + """ + REFUNDED + + """ + Returned + """ + RETURNED + + """ + Replaced + """ + REPLACED + + """ + Refunded and returned + """ + REFUNDED_AND_RETURNED + + """ + Canceled + """ + CANCELED +} + +""" +Represents line of the fulfillment. +""" +type FulfillmentLine implements Node { + """ + The ID of the object. + """ + id: ID! + quantity: Int! + orderLine: OrderLine +} + +""" +Represents order line of particular order. +""" +type OrderLine implements Node { + """ + The ID of the object. + """ + id: ID! + productName: String! + variantName: String! + productSku: String! + isShippingRequired: Boolean! + quantity: Int! + quantityFulfilled: Int! + unitDiscountReason: String + taxRate: Float! + digitalContentUrl: DigitalContentUrl + + """ + The main thumbnail for the ordered product. + """ + thumbnail( + """ + Size of thumbnail. + """ + size: Int + ): Image + + """ + Price of the single item in the order line. + """ + unitPrice: TaxedMoney! + + """ + Price of the single item in the order line without applied an order line discount. + """ + undiscountedUnitPrice: TaxedMoney! + + """ + The discount applied to the single order line. + """ + unitDiscount: Money! + + """ + Value of the discount. Can store fixed value or percent value + """ + unitDiscountValue: PositiveDecimal! + + """ + Price of the order line. + """ + totalPrice: TaxedMoney! + + """ + A purchased product variant. Note: this field may be null if the variant has been removed from stock at all. + """ + variant: ProductVariant + + """ + Product name in the customer's language + """ + translatedProductName: String! + + """ + Variant name in the customer's language + """ + translatedVariantName: String! + + """ + List of allocations across warehouses. + """ + allocations: [Allocation!] + + """ + Type of the discount: fixed or percent + """ + unitDiscountType: DiscountValueTypeEnum +} + +""" +Positive Decimal scalar implementation. + +Should be used in places where value must be positive. +""" +scalar PositiveDecimal + +""" +Represents allocation. +""" +type Allocation implements Node { + """ + The ID of the object. + """ + id: ID! + + """ + Quantity allocated for orders. + """ + quantity: Int! + + """ + The warehouse were items were allocated. + """ + warehouse: Warehouse! +} + +enum OrderAction { + """ + Represents the capture action. + """ + CAPTURE + + """ + Represents a mark-as-paid action. + """ + MARK_AS_PAID + + """ + Represents a refund action. + """ + REFUND + + """ + Represents a void action. + """ + VOID +} + +""" +Represents an Invoice. +""" +type Invoice implements ObjectWithMetadata & Job & Node { + """ + The ID of the object. + """ + id: ID! + + """ + List of public metadata items. Can be accessed without permissions. + """ + metadata: [MetadataItem]! + + """ + Job status. + """ + status: JobStatusEnum! + number: String + externalUrl: String + + """ + List of private metadata items.Requires proper staff permissions to access. + """ + privateMetadata: [MetadataItem]! + + """ + Created date time of job in ISO 8601 format. + """ + createdAt: DateTime! + + """ + Date time of job last update in ISO 8601 format. + """ + updatedAt: DateTime! + + """ + Job message. + """ + message: String + + """ + URL to download an invoice. + """ + url: String +} + +interface Job { + """ + Job status. + """ + status: JobStatusEnum! + + """ + Created date time of job in ISO 8601 format. + """ + createdAt: DateTime! + + """ + Date time of job last update in ISO 8601 format. + """ + updatedAt: DateTime! + + """ + Job message. + """ + message: String +} + +""" +An enumeration. +""" +enum JobStatusEnum { PENDING SUCCESS - FAILURE - ERROR + FAILED + DELETED } """ -An RFC 3986 and RFC 3987 compliant URI string. - -Example value: `"https://johns-apparel.myshopify.com"`. +An enumeration. """ -scalar URL - -""" -The measurement used to calculate a unit price for a product variant (e.g. $9.99 / 100ml). -""" -type UnitPriceMeasurement { - """ - The type of unit of measurement for the unit price measurement. - """ - measuredType: UnitPriceMeasurementMeasuredType - - """ - The quantity unit for the unit price measurement. - """ - quantityUnit: UnitPriceMeasurementMeasuredUnit - - """ - The quantity value for the unit price measurement. - """ - quantityValue: Float! - - """ - The reference unit for the unit price measurement. - """ - referenceUnit: UnitPriceMeasurementMeasuredUnit - - """ - The reference value for the unit price measurement. - """ - referenceValue: Int! +enum PaymentChargeStatusEnum { + NOT_CHARGED + PENDING + PARTIALLY_CHARGED + FULLY_CHARGED + PARTIALLY_REFUNDED + FULLY_REFUNDED + REFUSED + CANCELLED } """ -The accepted types of unit of measurement. +Represents a payment of a given type. """ -enum UnitPriceMeasurementMeasuredType { +type Payment implements Node { """ - Unit of measurements representing volumes. + The ID of the object. """ - VOLUME + id: ID! + gateway: String! + isActive: Boolean! + created: DateTime! + modified: DateTime! + token: String! + checkout: Checkout + order: Order + paymentMethodType: String! + customerIpAddress: String """ - Unit of measurements representing weights. + Internal payment status. """ - WEIGHT + chargeStatus: PaymentChargeStatusEnum! """ - Unit of measurements representing lengths. + List of actions that can be performed in the current state of a payment. """ - LENGTH + actions: [OrderAction]! """ - Unit of measurements representing areas. + Total amount of the payment. """ - AREA + total: Money + + """ + Total amount captured for this payment. + """ + capturedAmount: Money + + """ + List of all transactions within this payment. + """ + transactions: [Transaction] + + """ + Maximum amount of money that can be captured. + """ + availableCaptureAmount: Money + + """ + Maximum amount of money that can be refunded. + """ + availableRefundAmount: Money + + """ + The details of the card used for this payment. + """ + creditCard: CreditCard } """ -The valid units of measurement for a unit price measurement. +An object representing a single payment. """ -enum UnitPriceMeasurementMeasuredUnit { +type Transaction implements Node { """ - 1000 milliliters equals 1 liter. + The ID of the object. """ - ML + id: ID! + created: DateTime! + payment: Payment! + token: String! + kind: TransactionKind! + isSuccess: Boolean! + error: String + gatewayResponse: JSONString! """ - 100 centiliters equals 1 liter. + Total amount of the transaction. """ - CL - - """ - Metric system unit of volume. - """ - L - - """ - 1 cubic meter equals 1000 liters. - """ - M3 - - """ - 1000 milligrams equals 1 gram. - """ - MG - - """ - Metric system unit of weight. - """ - G - - """ - 1 kilogram equals 1000 grams. - """ - KG - - """ - 1000 millimeters equals 1 meter. - """ - MM - - """ - 100 centimeters equals 1 meter. - """ - CM - - """ - Metric system unit of length. - """ - M - - """ - Metric system unit of area. - """ - M2 + amount: Money } """ -Represents an error in the input of a mutation. +An enumeration. """ -type UserError implements DisplayableError { +enum TransactionKind { """ - Path to the input field which caused the error. + External reference """ - field: [String!] + EXTERNAL """ - The error message. + Authorization + """ + AUTH + + """ + Pending + """ + PENDING + + """ + Action to confirm + """ + ACTION_TO_CONFIRM + + """ + Refund + """ + REFUND + + """ + Refund in progress + """ + REFUND_ONGOING + + """ + Capture + """ + CAPTURE + + """ + Void + """ + VOID + + """ + Confirm + """ + CONFIRM + + """ + Cancel + """ + CANCEL +} + +type CreditCard { + """ + Card brand. + """ + brand: String! + + """ + First 4 digits of the card number. + """ + firstDigits: String + + """ + Last 4 digits of the card number. + """ + lastDigits: String! + + """ + Two-digit number representing the card’s expiration month. + """ + expMonth: Int + + """ + Four-digit number representing the card’s expiration year. + """ + expYear: Int +} + +""" +History log of the order. +""" +type OrderEvent implements Node { + """ + The ID of the object. + """ + id: ID! + + """ + Date when event happened at in ISO 8601 format. + """ + date: DateTime + + """ + Order event type. + """ + type: OrderEventsEnum + + """ + User who performed the action. + """ + user: User + + """ + Content of the event. + """ + message: String + + """ + Email of the customer. + """ + email: String + + """ + Type of an email sent to the customer. + """ + emailType: OrderEventsEmailsEnum + + """ + Amount of money. + """ + amount: Float + + """ + The payment ID from the payment gateway. + """ + paymentId: String + + """ + The payment gateway of the payment. + """ + paymentGateway: String + + """ + Number of items. + """ + quantity: Int + + """ + Composed ID of the Fulfillment. + """ + composedId: String + + """ + User-friendly number of an order. + """ + orderNumber: String + + """ + Number of an invoice related to the order. + """ + invoiceNumber: String + + """ + List of oversold lines names. + """ + oversoldItems: [String] + + """ + The concerned lines. + """ + lines: [OrderEventOrderLineObject] + + """ + The lines fulfilled. + """ + fulfilledItems: [FulfillmentLine] + + """ + The warehouse were items were restocked. + """ + warehouse: Warehouse + + """ + The transaction reference of captured payment. + """ + transactionReference: String + + """ + Define if shipping costs were included to the refund. + """ + shippingCostsIncluded: Boolean + + """ + The order which is related to this order. + """ + relatedOrder: Order + + """ + The discount applied to the order. + """ + discount: OrderEventDiscountObject +} + +""" +An enumeration. +""" +enum OrderEventsEnum { + DRAFT_CREATED + DRAFT_CREATED_FROM_REPLACE + ADDED_PRODUCTS + REMOVED_PRODUCTS + PLACED + PLACED_FROM_DRAFT + OVERSOLD_ITEMS + CANCELED + ORDER_MARKED_AS_PAID + ORDER_FULLY_PAID + ORDER_REPLACEMENT_CREATED + ORDER_DISCOUNT_ADDED + ORDER_DISCOUNT_AUTOMATICALLY_UPDATED + ORDER_DISCOUNT_UPDATED + ORDER_DISCOUNT_DELETED + ORDER_LINE_DISCOUNT_UPDATED + ORDER_LINE_DISCOUNT_REMOVED + UPDATED_ADDRESS + EMAIL_SENT + CONFIRMED + PAYMENT_AUTHORIZED + PAYMENT_CAPTURED + EXTERNAL_SERVICE_NOTIFICATION + PAYMENT_REFUNDED + PAYMENT_VOIDED + PAYMENT_FAILED + INVOICE_REQUESTED + INVOICE_GENERATED + INVOICE_UPDATED + INVOICE_SENT + FULFILLMENT_CANCELED + FULFILLMENT_RESTOCKED_ITEMS + FULFILLMENT_FULFILLED_ITEMS + FULFILLMENT_REFUNDED + FULFILLMENT_RETURNED + FULFILLMENT_REPLACED + TRACKING_UPDATED + NOTE_ADDED + OTHER +} + +""" +An enumeration. +""" +enum OrderEventsEmailsEnum { + PAYMENT_CONFIRMATION + CONFIRMED + SHIPPING_CONFIRMATION + TRACKING_UPDATED + ORDER_CONFIRMATION + ORDER_CANCEL + ORDER_REFUND + FULFILLMENT_CONFIRMATION + DIGITAL_LINKS +} + +type OrderEventOrderLineObject { + """ + The variant quantity. + """ + quantity: Int + + """ + The order line. + """ + orderLine: OrderLine + + """ + The variant name. + """ + itemName: String + + """ + The discount applied to the order line. + """ + discount: OrderEventDiscountObject +} + +type OrderEventDiscountObject { + """ + Type of the discount: fixed or percent. + """ + valueType: DiscountValueTypeEnum! + + """ + Value of the discount. Can store fixed value or percent value. + """ + value: PositiveDecimal! + + """ + Explanation for the applied discount. + """ + reason: String + + """ + Returns amount of discount. + """ + amount: Money + + """ + Type of the discount: fixed or percent. + """ + oldValueType: DiscountValueTypeEnum + + """ + Value of the discount. Can store fixed value or percent value. + """ + oldValue: PositiveDecimal + + """ + Returns amount of discount. + """ + oldAmount: Money +} + +""" +Contains all details related to the applied discount to the order. +""" +type OrderDiscount implements Node { + """ + The ID of the object. + """ + id: ID! + type: OrderDiscountType! + + """ + Type of the discount: fixed or percent + """ + valueType: DiscountValueTypeEnum! + + """ + Value of the discount. Can store fixed value or percent value + """ + value: PositiveDecimal! + name: String + translatedName: String + + """ + Explanation for the applied discount. + """ + reason: String + + """ + Returns amount of discount. + """ + amount: Money! +} + +""" +An enumeration. +""" +enum OrderDiscountType { + """ + Voucher + """ + VOUCHER + + """ + Manual + """ + MANUAL +} + +type UserPermission { + """ + Internal code for permission. + """ + code: PermissionEnum! + + """ + Describe action(s) allowed to do by permission. + """ + name: String! + + """ + List of user permission groups which contains this permission. + """ + sourcePermissionGroups( + """ + ID of user whose groups should be returned. + """ + userId: ID! + ): [Group!] +} + +""" +Represents permission group data. +""" +type Group implements Node { + """ + The ID of the object. + """ + id: ID! + name: String! + + """ + List of group permissions + """ + permissions: [Permission] + + """ + List of group users + """ + users: [User] + + """ + True, if the currently authenticated user has rights to manage a group. + """ + userCanManage: Boolean! +} + +""" +History log of the customer. +""" +type CustomerEvent implements Node { + """ + The ID of the object. + """ + id: ID! + + """ + Date when event happened at in ISO 8601 format. + """ + date: DateTime + + """ + Customer event type. + """ + type: CustomerEventsEnum + + """ + User who performed the action. + """ + user: User + + """ + Content of the event. + """ + message: String + + """ + Number of objects concerned by the event. + """ + count: Int + + """ + The concerned order. + """ + order: Order + + """ + The concerned order line. + """ + orderLine: OrderLine +} + +""" +An enumeration. +""" +enum CustomerEventsEnum { + ACCOUNT_CREATED + PASSWORD_RESET_LINK_SENT + PASSWORD_RESET + EMAIL_CHANGED_REQUEST + PASSWORD_CHANGED + EMAIL_CHANGED + PLACED_ORDER + NOTE_ADDED_TO_ORDER + DIGITAL_LINK_DOWNLOADED + CUSTOMER_DELETED + NAME_ASSIGNED + EMAIL_ASSIGNED + NOTE_ADDED +} + +""" +Represents a payment source stored for user in payment gateway, such as credit card. +""" +type PaymentSource { + """ + Payment gateway name. + """ + gateway: String! + + """ + Stored credit card details if available. + """ + creditCardInfo: CreditCard +} + +type LimitInfo { + """ + Defines the current resource usage. + """ + currentUsage: Limits! + + """ + Defines the allowed maximum resource usage, null means unlimited. + """ + allowedUsage: Limits! +} + +type Limits { + channels: Int + orders: Int + productVariants: Int + staffUsers: Int + warehouses: Int +} + +""" +Order related settings from site settings. +""" +type OrderSettings { + automaticallyConfirmAllNewOrders: Boolean! +} + +input ShippingZoneFilterInput { + search: String +} + +type DigitalContentCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [DigitalContentCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type DigitalContentCountableEdge { + """ + The item at the end of the edge. + """ + node: DigitalContent! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input CategoryFilterInput { + search: String + metadata: [MetadataInput] + ids: [ID] +} + +input CategorySortingInput { + """ + Specifies the direction in which to sort products. + """ + direction: OrderDirection! + + """ + Specifies the channel in which to sort the data. + """ + channel: String + + """ + Sort categories by the selected field. + """ + field: CategorySortField! +} + +enum CategorySortField { + """ + Sort categories by name. + """ + NAME + + """ + Sort categories by product count. + """ + PRODUCT_COUNT + + """ + Sort categories by subcategory count. + """ + SUBCATEGORY_COUNT +} + +input CollectionFilterInput { + published: CollectionPublished + search: String + metadata: [MetadataInput] + ids: [ID] + + """ + Specifies the channel by which the data should be sorted. + """ + channel: String +} + +enum CollectionPublished { + PUBLISHED + HIDDEN +} + +input CollectionSortingInput { + """ + Specifies the direction in which to sort products. + """ + direction: OrderDirection! + + """ + Specifies the channel in which to sort the data. + """ + channel: String + + """ + Sort collections by the selected field. + """ + field: CollectionSortField! +} + +enum CollectionSortField { + """ + Sort collections by name. + """ + NAME + + """ + Sort collections by availability. + """ + AVAILABILITY + + """ + Sort collections by product count. + """ + PRODUCT_COUNT + + """ + Sort collections by publication date. + """ + PUBLICATION_DATE +} + +input ProductTypeFilterInput { + search: String + configurable: ProductTypeConfigurable + productType: ProductTypeEnum + metadata: [MetadataInput] + ids: [ID] +} + +enum ProductTypeConfigurable { + CONFIGURABLE + SIMPLE +} + +enum ProductTypeEnum { + DIGITAL + SHIPPABLE +} + +input ProductTypeSortingInput { + """ + Specifies the direction in which to sort products. + """ + direction: OrderDirection! + + """ + Sort product types by the selected field. + """ + field: ProductTypeSortField! +} + +enum ProductTypeSortField { + """ + Sort products by name. + """ + NAME + + """ + Sort products by type. + """ + DIGITAL + + """ + Sort products by shipping. + """ + SHIPPING_REQUIRED +} + +type ProductVariantCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [ProductVariantCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type ProductVariantCountableEdge { + """ + The item at the end of the edge. + """ + node: ProductVariant! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input ProductVariantFilterInput { + search: String + sku: [String] + metadata: [MetadataInput] +} + +type PaymentCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [PaymentCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type PaymentCountableEdge { + """ + The item at the end of the edge. + """ + node: Payment! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input PaymentFilterInput { + checkouts: [ID] +} + +type PageCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [PageCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type PageCountableEdge { + """ + The item at the end of the edge. + """ + node: Page! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input PageSortingInput { + """ + Specifies the direction in which to sort products. + """ + direction: OrderDirection! + + """ + Sort pages by the selected field. + """ + field: PageSortField! +} + +enum PageSortField { + """ + Sort pages by title. + """ + TITLE + + """ + Sort pages by slug. + """ + SLUG + + """ + Sort pages by visibility. + """ + VISIBILITY + + """ + Sort pages by creation date. + """ + CREATION_DATE + + """ + Sort pages by publication date. + """ + PUBLICATION_DATE +} + +input PageFilterInput { + search: String + metadata: [MetadataInput] +} + +type PageTypeCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [PageTypeCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type PageTypeCountableEdge { + """ + The item at the end of the edge. + """ + node: PageType! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input PageTypeSortingInput { + """ + Specifies the direction in which to sort products. + """ + direction: OrderDirection! + + """ + Sort page types by the selected field. + """ + field: PageTypeSortField! +} + +enum PageTypeSortField { + """ + Sort page types by name. + """ + NAME + + """ + Sort page types by slug. + """ + SLUG +} + +input PageTypeFilterInput { + search: String +} + +type OrderEventCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [OrderEventCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type OrderEventCountableEdge { + """ + The item at the end of the edge. + """ + node: OrderEvent! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input OrderSortingInput { + """ + Specifies the direction in which to sort products. + """ + direction: OrderDirection! + + """ + Sort orders by the selected field. + """ + field: OrderSortField! +} + +enum OrderSortField { + """ + Sort orders by number. + """ + NUMBER + + """ + Sort orders by creation date. + """ + CREATION_DATE + + """ + Sort orders by customer. + """ + CUSTOMER + + """ + Sort orders by payment. + """ + PAYMENT + + """ + Sort orders by fulfillment status. + """ + FULFILLMENT_STATUS +} + +input OrderFilterInput { + paymentStatus: [PaymentChargeStatusEnum] + status: [OrderStatusFilter] + customer: String + created: DateRangeInput + search: String + metadata: [MetadataInput] + channels: [ID] +} + +enum OrderStatusFilter { + READY_TO_FULFILL + READY_TO_CAPTURE + UNFULFILLED + UNCONFIRMED + PARTIALLY_FULFILLED + FULFILLED + CANCELED +} + +input DateRangeInput { + """ + Start date. + """ + gte: Date + + """ + End date. + """ + lte: Date +} + +input OrderDraftFilterInput { + customer: String + created: DateRangeInput + search: String + metadata: [MetadataInput] + channels: [ID] +} + +type MenuCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [MenuCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type MenuCountableEdge { + """ + The item at the end of the edge. + """ + node: Menu! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input MenuSortingInput { + """ + Specifies the direction in which to sort products. + """ + direction: OrderDirection! + + """ + Sort menus by the selected field. + """ + field: MenuSortField! +} + +enum MenuSortField { + """ + Sort menus by name. + """ + NAME + + """ + Sort menus by items count. + """ + ITEMS_COUNT +} + +input MenuFilterInput { + search: String + slug: [String] + metadata: [MetadataInput] +} + +type MenuItemCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [MenuItemCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type MenuItemCountableEdge { + """ + The item at the end of the edge. + """ + node: MenuItem! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input MenuItemSortingInput { + """ + Specifies the direction in which to sort products. + """ + direction: OrderDirection! + + """ + Sort menu items by the selected field. + """ + field: MenuItemsSortField! +} + +enum MenuItemsSortField { + """ + Sort menu items by name. + """ + NAME +} + +input MenuItemFilterInput { + search: String + metadata: [MetadataInput] +} + +""" +Plugin. +""" +type Plugin implements Node { + id: ID! + name: String! + description: String! + active: Boolean! + configuration: [ConfigurationItem] +} + +""" +Stores information about a single configuration field. +""" +type ConfigurationItem { + """ + Name of the field. + """ + name: String! + + """ + Current value of the field. + """ + value: String + + """ + Type of the field. + """ + type: ConfigurationTypeFieldEnum + + """ + Help text for the field. + """ + helpText: String + + """ + Label for the field. + """ + label: String +} + +""" +An enumeration. +""" +enum ConfigurationTypeFieldEnum { + STRING + MULTILINE + BOOLEAN + SECRET + PASSWORD + SECRETMULTILINE +} + +type PluginCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [PluginCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type PluginCountableEdge { + """ + The item at the end of the edge. + """ + node: Plugin! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input PluginFilterInput { + active: Boolean + search: String +} + +input PluginSortingInput { + """ + Specifies the direction in which to sort products. + """ + direction: OrderDirection! + + """ + Sort plugins by the selected field. + """ + field: PluginSortField! +} + +enum PluginSortField { + NAME + IS_ACTIVE +} + +type SaleCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [SaleCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type SaleCountableEdge { + """ + The item at the end of the edge. + """ + node: Sale! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input SaleFilterInput { + status: [DiscountStatusEnum] + saleType: DiscountValueTypeEnum + started: DateTimeRangeInput + search: String +} + +enum DiscountStatusEnum { + ACTIVE + EXPIRED + SCHEDULED +} + +input DateTimeRangeInput { + """ + Start date. + """ + gte: DateTime + + """ + End date. + """ + lte: DateTime +} + +input SaleSortingInput { + """ + Specifies the direction in which to sort products. + """ + direction: OrderDirection! + + """ + Specifies the channel in which to sort the data. + """ + channel: String + + """ + Sort sales by the selected field. + """ + field: SaleSortField! +} + +enum SaleSortField { + """ + Sort sales by name. + """ + NAME + + """ + Sort sales by start date. + """ + START_DATE + + """ + Sort sales by end date. + """ + END_DATE + + """ + Sort sales by value. + """ + VALUE + + """ + Sort sales by type. + """ + TYPE +} + +type VoucherCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [VoucherCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type VoucherCountableEdge { + """ + The item at the end of the edge. + """ + node: Voucher! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input VoucherFilterInput { + status: [DiscountStatusEnum] + timesUsed: IntRangeInput + discountType: [VoucherDiscountType] + started: DateTimeRangeInput + search: String +} + +enum VoucherDiscountType { + FIXED + PERCENTAGE + SHIPPING +} + +input VoucherSortingInput { + """ + Specifies the direction in which to sort products. + """ + direction: OrderDirection! + + """ + Specifies the channel in which to sort the data. + """ + channel: String + + """ + Sort vouchers by the selected field. + """ + field: VoucherSortField! +} + +enum VoucherSortField { + """ + Sort vouchers by code. + """ + CODE + + """ + Sort vouchers by start date. + """ + START_DATE + + """ + Sort vouchers by end date. + """ + END_DATE + + """ + Sort vouchers by value. + """ + VALUE + + """ + Sort vouchers by type. + """ + TYPE + + """ + Sort vouchers by usage limit. + """ + USAGE_LIMIT + + """ + Sort vouchers by minimum spent amount. + """ + MINIMUM_SPENT_AMOUNT +} + +""" +Represents a job data of exported file. +""" +type ExportFile implements Node & Job { + """ + The ID of the object. + """ + id: ID! + user: User + app: App + + """ + Job status. + """ + status: JobStatusEnum! + + """ + Created date time of job in ISO 8601 format. + """ + createdAt: DateTime! + + """ + Date time of job last update in ISO 8601 format. + """ + updatedAt: DateTime! + + """ + Job message. + """ + message: String + + """ + The URL of field to download. + """ + url: String + + """ + List of events associated with the export. + """ + events: [ExportEvent!] +} + +""" +History log of export file. +""" +type ExportEvent implements Node { + """ + The ID of the object. + """ + id: ID! + + """ + Date when event happened at in ISO 8601 format. + """ + date: DateTime! + + """ + Export event type. + """ + type: ExportEventsEnum! + + """ + User who performed the action. + """ + user: User + + """ + App which performed the action. + """ + app: App + + """ + Content of the event. """ message: String! } """ -Represents a Shopify hosted video. +An enumeration. """ -type Video implements Node & Media { +enum ExportEventsEnum { + EXPORT_PENDING + EXPORT_SUCCESS + EXPORT_FAILED + EXPORT_DELETED + EXPORTED_FILE_SENT + EXPORT_FAILED_INFO_SENT +} + +type ExportFileCountableConnection { """ - A word or phrase to share the nature or contents of a media. + Pagination data for this connection. """ - alt: String + pageInfo: PageInfo! + edges: [ExportFileCountableEdge!]! """ - Globally unique identifier. + A total count of items in the collection. + """ + totalCount: Int +} + +type ExportFileCountableEdge { + """ + The item at the end of the edge. + """ + node: ExportFile! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input ExportFileFilterInput { + createdAt: DateTimeRangeInput + updatedAt: DateTimeRangeInput + status: JobStatusEnum + user: String + app: String +} + +input ExportFileSortingInput { + """ + Specifies the direction in which to sort products. + """ + direction: OrderDirection! + + """ + Sort export file by the selected field. + """ + field: ExportFileSortField! +} + +enum ExportFileSortField { + """ + Sort export file by status. + """ + STATUS + + """ + Sort export file by created at. + """ + CREATED_AT + + """ + Sort export file by updated at. + """ + UPDATED_AT +} + +type CheckoutCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [CheckoutCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type CheckoutCountableEdge { + """ + The item at the end of the edge. + """ + node: Checkout! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +type CheckoutLineCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [CheckoutLineCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type CheckoutLineCountableEdge { + """ + The item at the end of the edge. + """ + node: CheckoutLine! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input AttributeSortingInput { + """ + Specifies the direction in which to sort products. + """ + direction: OrderDirection! + + """ + Sort attributes by the selected field. + """ + field: AttributeSortField! +} + +enum AttributeSortField { + """ + Sort attributes by name + """ + NAME + + """ + Sort attributes by slug + """ + SLUG + + """ + Sort attributes by the value required flag + """ + VALUE_REQUIRED + + """ + Sort attributes by the variant only flag + """ + IS_VARIANT_ONLY + + """ + Sort attributes by visibility in the storefront + """ + VISIBLE_IN_STOREFRONT + + """ + Sort attributes by the filterable in storefront flag + """ + FILTERABLE_IN_STOREFRONT + + """ + Sort attributes by the filterable in dashboard flag + """ + FILTERABLE_IN_DASHBOARD + + """ + Sort attributes by their position in storefront + """ + STOREFRONT_SEARCH_POSITION + + """ + Sort attributes based on whether they can be displayed or not in a product grid. + """ + AVAILABLE_IN_GRID +} + +""" +Represents ongoing installation of app. +""" +type AppInstallation implements Node & Job { + appName: String! + manifestUrl: String! + + """ + The ID of the object. """ id: ID! """ - The media content type. + Job status. """ - mediaContentType: MediaContentType! + status: JobStatusEnum! """ - The preview image for the media. + Created date time of job in ISO 8601 format. """ - previewImage: Image + createdAt: DateTime! """ - The sources for a video. + Date time of job last update in ISO 8601 format. """ - sources: [VideoSource!]! + updatedAt: DateTime! + + """ + Job message. + """ + message: String +} + +type AppCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [AppCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type AppCountableEdge { + """ + The item at the end of the edge. + """ + node: App! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input AppFilterInput { + search: String + isActive: Boolean + type: AppTypeEnum +} + +input AppSortingInput { + """ + Specifies the direction in which to sort products. + """ + direction: OrderDirection! + + """ + Sort apps by the selected field. + """ + field: AppSortField! +} + +enum AppSortField { + """ + Sort apps by name. + """ + NAME + + """ + Sort apps by creation date. + """ + CREATION_DATE +} + +type AddressValidationData { + countryCode: String + countryName: String + addressFormat: String + addressLatinFormat: String + allowedFields: [String] + requiredFields: [String] + upperFields: [String] + countryAreaType: String + countryAreaChoices: [ChoiceValue] + cityType: String + cityChoices: [ChoiceValue] + cityAreaType: String + cityAreaChoices: [ChoiceValue] + postalCodeType: String + postalCodeMatchers: [String] + postalCodeExamples: [String] + postalCodePrefix: String +} + +type ChoiceValue { + raw: String + verbose: String +} + +type UserCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [UserCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type UserCountableEdge { + """ + The item at the end of the edge. + """ + node: User! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input CustomerFilterInput { + dateJoined: DateRangeInput + numberOfOrders: IntRangeInput + placedOrders: DateRangeInput + search: String +} + +input UserSortingInput { + """ + Specifies the direction in which to sort products. + """ + direction: OrderDirection! + + """ + Sort users by the selected field. + """ + field: UserSortField! +} + +enum UserSortField { + """ + Sort users by first name. + """ + FIRST_NAME + + """ + Sort users by last name. + """ + LAST_NAME + + """ + Sort users by email. + """ + EMAIL + + """ + Sort users by order count. + """ + ORDER_COUNT +} + +type GroupCountableConnection { + """ + Pagination data for this connection. + """ + pageInfo: PageInfo! + edges: [GroupCountableEdge!]! + + """ + A total count of items in the collection. + """ + totalCount: Int +} + +type GroupCountableEdge { + """ + The item at the end of the edge. + """ + node: Group! + + """ + A cursor for use in pagination. + """ + cursor: String! +} + +input PermissionGroupFilterInput { + search: String +} + +input PermissionGroupSortingInput { + """ + Specifies the direction in which to sort products. + """ + direction: OrderDirection! + + """ + Sort permission group by the selected field. + """ + field: PermissionGroupSortField! +} + +enum PermissionGroupSortField { + """ + Sort permission group accounts by name. + """ + NAME +} + +input StaffUserInput { + status: StaffMemberStatus + search: String +} + +enum StaffMemberStatus { + """ + User account has been activated. + """ + ACTIVE + + """ + User account has not been activated yet. + """ + DEACTIVATED +} + +union _Entity = + Address + | User + | Group + | App + | ProductVariant + | Product + | ProductType + | Collection + | Category + | ProductMedia + | ProductImage + | PageType + +""" +Anything +""" +scalar _Any + +type _Service { + sdl: String +} + +type Mutation { + """ + Creates a new webhook subscription. + """ + webhookCreate( + """ + Fields required to create a webhook. + """ + input: WebhookCreateInput! + ): WebhookCreate + + """ + Deletes a webhook subscription. + """ + webhookDelete( + """ + ID of a webhook to delete. + """ + id: ID! + ): WebhookDelete + + """ + Updates a webhook subscription. + """ + webhookUpdate( + """ + ID of a webhook to update. + """ + id: ID! + + """ + Fields required to update a webhook. + """ + input: WebhookUpdateInput! + ): WebhookUpdate + + """ + Creates new warehouse. + """ + createWarehouse( + """ + Fields required to create warehouse. + """ + input: WarehouseCreateInput! + ): WarehouseCreate + + """ + Updates given warehouse. + """ + updateWarehouse( + """ + ID of a warehouse to update. + """ + id: ID! + + """ + Fields required to update warehouse. + """ + input: WarehouseUpdateInput! + ): WarehouseUpdate + + """ + Deletes selected warehouse. + """ + deleteWarehouse( + """ + ID of a warehouse to delete. + """ + id: ID! + ): WarehouseDelete + + """ + Add shipping zone to given warehouse. + """ + assignWarehouseShippingZone( + """ + ID of a warehouse to update. + """ + id: ID! + + """ + List of shipping zone IDs. + """ + shippingZoneIds: [ID!]! + ): WarehouseShippingZoneAssign + + """ + Remove shipping zone from given warehouse. + """ + unassignWarehouseShippingZone( + """ + ID of a warehouse to update. + """ + id: ID! + + """ + List of shipping zone IDs. + """ + shippingZoneIds: [ID!]! + ): WarehouseShippingZoneUnassign + + """ + Creates a new staff notification recipient. + """ + staffNotificationRecipientCreate( + """ + Fields required to create a staff notification recipient. + """ + input: StaffNotificationRecipientInput! + ): StaffNotificationRecipientCreate + + """ + Updates a staff notification recipient. + """ + staffNotificationRecipientUpdate( + """ + ID of a staff notification recipient to update. + """ + id: ID! + + """ + Fields required to update a staff notification recipient. + """ + input: StaffNotificationRecipientInput! + ): StaffNotificationRecipientUpdate + + """ + Delete staff notification recipient. + """ + staffNotificationRecipientDelete( + """ + ID of a staff notification recipient to delete. + """ + id: ID! + ): StaffNotificationRecipientDelete + + """ + Updates site domain of the shop. + """ + shopDomainUpdate( + """ + Fields required to update site. + """ + input: SiteDomainInput + ): ShopDomainUpdate + + """ + Updates shop settings. + """ + shopSettingsUpdate( + """ + Fields required to update shop settings. + """ + input: ShopSettingsInput! + ): ShopSettingsUpdate + + """ + Fetch tax rates. + """ + shopFetchTaxRates: ShopFetchTaxRates + + """ + Creates/Updates translations for Shop Settings. + """ + shopSettingsTranslate( + """ + Fields required to update shop settings translations. + """ + input: ShopSettingsTranslationInput! + + """ + Translation language code. + """ + languageCode: LanguageCodeEnum! + ): ShopSettingsTranslate + + """ + Update the shop's address. If the `null` value is passed, the currently selected address will be deleted. + """ + shopAddressUpdate( + """ + Fields required to update shop address. + """ + input: AddressInput + ): ShopAddressUpdate + + """ + Update shop order settings. + """ + orderSettingsUpdate( + """ + Fields required to update shop order settings. + """ + input: OrderSettingsUpdateInput! + ): OrderSettingsUpdate + + """ + Manage shipping method's availability in channels. + """ + shippingMethodChannelListingUpdate( + """ + ID of a shipping method to update. + """ + id: ID! + + """ + Fields required to update shipping method channel listings. + """ + input: ShippingMethodChannelListingInput! + ): ShippingMethodChannelListingUpdate + + """ + Creates a new shipping price. + """ + shippingPriceCreate( + """ + Fields required to create a shipping price. + """ + input: ShippingPriceInput! + ): ShippingPriceCreate + + """ + Deletes a shipping price. + """ + shippingPriceDelete( + """ + ID of a shipping price to delete. + """ + id: ID! + ): ShippingPriceDelete + + """ + Deletes shipping prices. + """ + shippingPriceBulkDelete( + """ + List of shipping price IDs to delete. + """ + ids: [ID]! + ): ShippingPriceBulkDelete + + """ + Updates a new shipping price. + """ + shippingPriceUpdate( + """ + ID of a shipping price to update. + """ + id: ID! + + """ + Fields required to update a shipping price. + """ + input: ShippingPriceInput! + ): ShippingPriceUpdate + + """ + Creates/Updates translations for shipping method. + """ + shippingPriceTranslate( + """ + Shipping method ID. + """ + id: ID! + input: NameTranslationInput! + + """ + Translation language code. + """ + languageCode: LanguageCodeEnum! + ): ShippingPriceTranslate + + """ + Exclude products from shipping price. + """ + shippingPriceExcludeProducts( + """ + ID of a shipping price. + """ + id: ID! + + """ + Exclude products input. + """ + input: ShippingPriceExcludeProductsInput! + ): ShippingPriceExcludeProducts + + """ + Remove product from excluded list for shipping price. + """ + shippingPriceRemoveProductFromExclude( + """ + ID of a shipping price. + """ + id: ID! + + """ + List of products which will be removed from excluded list. + """ + products: [ID]! + ): ShippingPriceRemoveProductFromExclude + + """ + Creates a new shipping zone. + """ + shippingZoneCreate( + """ + Fields required to create a shipping zone. + """ + input: ShippingZoneCreateInput! + ): ShippingZoneCreate + + """ + Deletes a shipping zone. + """ + shippingZoneDelete( + """ + ID of a shipping zone to delete. + """ + id: ID! + ): ShippingZoneDelete + + """ + Deletes shipping zones. + """ + shippingZoneBulkDelete( + """ + List of shipping zone IDs to delete. + """ + ids: [ID]! + ): ShippingZoneBulkDelete + + """ + Updates a new shipping zone. + """ + shippingZoneUpdate( + """ + ID of a shipping zone to update. + """ + id: ID! + + """ + Fields required to update a shipping zone. + """ + input: ShippingZoneUpdateInput! + ): ShippingZoneUpdate + + """ + Assign attributes to a given product type. + """ + productAttributeAssign( + """ + The operations to perform. + """ + operations: [ProductAttributeAssignInput]! + + """ + ID of the product type to assign the attributes into. + """ + productTypeId: ID! + ): ProductAttributeAssign + + """ + Un-assign attributes from a given product type. + """ + productAttributeUnassign( + """ + The IDs of the attributes to unassign. + """ + attributeIds: [ID]! + + """ + ID of the product type from which the attributes should be unassigned. + """ + productTypeId: ID! + ): ProductAttributeUnassign + + """ + Creates a new category. + """ + categoryCreate( + """ + Fields required to create a category. + """ + input: CategoryInput! + + """ + ID of the parent category. If empty, category will be top level category. + """ + parent: ID + ): CategoryCreate + + """ + Deletes a category. + """ + categoryDelete( + """ + ID of a category to delete. + """ + id: ID! + ): CategoryDelete + + """ + Deletes categories. + """ + categoryBulkDelete( + """ + List of category IDs to delete. + """ + ids: [ID]! + ): CategoryBulkDelete + + """ + Updates a category. + """ + categoryUpdate( + """ + ID of a category to update. + """ + id: ID! + + """ + Fields required to update a category. + """ + input: CategoryInput! + ): CategoryUpdate + + """ + Creates/Updates translations for Category. + """ + categoryTranslate( + """ + Category ID. + """ + id: ID! + input: TranslationInput! + + """ + Translation language code. + """ + languageCode: LanguageCodeEnum! + ): CategoryTranslate + + """ + Adds products to a collection. + """ + collectionAddProducts( + """ + ID of a collection. + """ + collectionId: ID! + + """ + List of product IDs. + """ + products: [ID]! + ): CollectionAddProducts + + """ + Creates a new collection. + """ + collectionCreate( + """ + Fields required to create a collection. + """ + input: CollectionCreateInput! + ): CollectionCreate + + """ + Deletes a collection. + """ + collectionDelete( + """ + ID of a collection to delete. + """ + id: ID! + ): CollectionDelete + + """ + Reorder the products of a collection. + """ + collectionReorderProducts( + """ + ID of a collection. + """ + collectionId: ID! + + """ + The collection products position operations. + """ + moves: [MoveProductInput]! + ): CollectionReorderProducts + + """ + Deletes collections. + """ + collectionBulkDelete( + """ + List of collection IDs to delete. + """ + ids: [ID]! + ): CollectionBulkDelete + + """ + Remove products from a collection. + """ + collectionRemoveProducts( + """ + ID of a collection. + """ + collectionId: ID! + + """ + List of product IDs. + """ + products: [ID]! + ): CollectionRemoveProducts + + """ + Updates a collection. + """ + collectionUpdate( + """ + ID of a collection to update. + """ + id: ID! + + """ + Fields required to update a collection. + """ + input: CollectionInput! + ): CollectionUpdate + + """ + Creates/Updates translations for collection. + """ + collectionTranslate( + """ + Collection ID. + """ + id: ID! + input: TranslationInput! + + """ + Translation language code. + """ + languageCode: LanguageCodeEnum! + ): CollectionTranslate + + """ + Manage collection's availability in channels. + """ + collectionChannelListingUpdate( + """ + ID of a collection to update. + """ + id: ID! + + """ + Fields required to create or update collection channel listings. + """ + input: CollectionChannelListingUpdateInput! + ): CollectionChannelListingUpdate + + """ + Creates a new product. + """ + productCreate( + """ + Fields required to create a product. + """ + input: ProductCreateInput! + ): ProductCreate + + """ + Deletes a product. + """ + productDelete( + """ + ID of a product to delete. + """ + id: ID! + ): ProductDelete + + """ + Deletes products. + """ + productBulkDelete( + """ + List of product IDs to delete. + """ + ids: [ID]! + ): ProductBulkDelete + + """ + Updates an existing product. + """ + productUpdate( + """ + ID of a product to update. + """ + id: ID! + + """ + Fields required to update a product. + """ + input: ProductInput! + ): ProductUpdate + + """ + Creates/Updates translations for Product. + """ + productTranslate( + """ + Product ID. + """ + id: ID! + input: TranslationInput! + + """ + Translation language code. + """ + languageCode: LanguageCodeEnum! + ): ProductTranslate + + """ + Manage product's availability in channels. + """ + productChannelListingUpdate( + """ + ID of a product to update. + """ + id: ID! + + """ + Fields required to create or update product channel listings. + """ + input: ProductChannelListingUpdateInput! + ): ProductChannelListingUpdate + + """ + Create a media object (image or video URL) associated with product. For image, this mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec + """ + productMediaCreate( + """ + Fields required to create a product media. + """ + input: ProductMediaCreateInput! + ): ProductMediaCreate + + """ + Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook. + """ + productVariantReorder( + """ + The list of variant reordering operations. + """ + moves: [ReorderInput]! + + """ + Id of product that variants order will be altered. + """ + productId: ID! + ): ProductVariantReorder + + """ + Deletes a product media. + """ + productMediaDelete( + """ + ID of a product media to delete. + """ + id: ID! + ): ProductMediaDelete + + """ + Deletes product media. + """ + productMediaBulkDelete( + """ + List of product media IDs to delete. + """ + ids: [ID]! + ): ProductMediaBulkDelete + + """ + Changes ordering of the product media. + """ + productMediaReorder( + """ + IDs of a product media in the desired order. + """ + mediaIds: [ID]! + + """ + ID of product that media order will be altered. + """ + productId: ID! + ): ProductMediaReorder + + """ + Updates a product media. + """ + productMediaUpdate( + """ + ID of a product media to update. + """ + id: ID! + + """ + Fields required to update a product media. + """ + input: ProductMediaUpdateInput! + ): ProductMediaUpdate + + """ + Creates a new product type. + """ + productTypeCreate( + """ + Fields required to create a product type. + """ + input: ProductTypeInput! + ): ProductTypeCreate + + """ + Deletes a product type. + """ + productTypeDelete( + """ + ID of a product type to delete. + """ + id: ID! + ): ProductTypeDelete + + """ + Deletes product types. + """ + productTypeBulkDelete( + """ + List of product type IDs to delete. + """ + ids: [ID]! + ): ProductTypeBulkDelete + + """ + Updates an existing product type. + """ + productTypeUpdate( + """ + ID of a product type to update. + """ + id: ID! + + """ + Fields required to update a product type. + """ + input: ProductTypeInput! + ): ProductTypeUpdate + + """ + Reorder the attributes of a product type. + """ + productTypeReorderAttributes( + """ + The list of attribute reordering operations. + """ + moves: [ReorderInput]! + + """ + ID of a product type. + """ + productTypeId: ID! + + """ + The attribute type to reorder. + """ + type: ProductAttributeType! + ): ProductTypeReorderAttributes + + """ + Reorder product attribute values. + """ + productReorderAttributeValues( + """ + ID of an attribute. + """ + attributeId: ID! + + """ + The list of reordering operations for given attribute values. + """ + moves: [ReorderInput]! + + """ + ID of a product. + """ + productId: ID! + ): ProductReorderAttributeValues + + """ + Create new digital content. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec + """ + digitalContentCreate( + """ + Fields required to create a digital content. + """ + input: DigitalContentUploadInput! + + """ + ID of a product variant to upload digital content. + """ + variantId: ID! + ): DigitalContentCreate + + """ + Remove digital content assigned to given variant. + """ + digitalContentDelete( + """ + ID of a product variant with digital content to remove. + """ + variantId: ID! + ): DigitalContentDelete + + """ + Update digital content. + """ + digitalContentUpdate( + """ + Fields required to update a digital content. + """ + input: DigitalContentInput! + + """ + ID of a product variant with digital content to update. + """ + variantId: ID! + ): DigitalContentUpdate + + """ + Generate new URL to digital content. + """ + digitalContentUrlCreate( + """ + Fields required to create a new url. + """ + input: DigitalContentUrlCreateInput! + ): DigitalContentUrlCreate + + """ + Creates a new variant for a product. + """ + productVariantCreate( + """ + Fields required to create a product variant. + """ + input: ProductVariantCreateInput! + ): ProductVariantCreate + + """ + Deletes a product variant. + """ + productVariantDelete( + """ + ID of a product variant to delete. + """ + id: ID! + ): ProductVariantDelete + + """ + Creates product variants for a given product. + """ + productVariantBulkCreate( + """ + ID of the product to create the variants for. + """ + product: ID! + + """ + Input list of product variants to create. + """ + variants: [ProductVariantBulkCreateInput]! + ): ProductVariantBulkCreate + + """ + Deletes product variants. + """ + productVariantBulkDelete( + """ + List of product variant IDs to delete. + """ + ids: [ID]! + ): ProductVariantBulkDelete + + """ + Creates stocks for product variant. + """ + productVariantStocksCreate( + """ + Input list of stocks to create. + """ + stocks: [StockInput!]! + + """ + ID of a product variant for which stocks will be created. + """ + variantId: ID! + ): ProductVariantStocksCreate + + """ + Delete stocks from product variant. + """ + productVariantStocksDelete( + """ + ID of product variant for which stocks will be deleted. + """ + variantId: ID! + warehouseIds: [ID!] + ): ProductVariantStocksDelete + + """ + Update stocks for product variant. + """ + productVariantStocksUpdate( + """ + Input list of stocks to create. + """ + stocks: [StockInput!]! + + """ + ID of a product variant for which stocks will be created. + """ + variantId: ID! + ): ProductVariantStocksUpdate + + """ + Updates an existing variant for product. + """ + productVariantUpdate( + """ + ID of a product variant to update. + """ + id: ID! + + """ + Fields required to update a product variant. + """ + input: ProductVariantInput! + ): ProductVariantUpdate + + """ + Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook. + """ + productVariantSetDefault( + """ + Id of a product that will have the default variant set. + """ + productId: ID! + + """ + Id of a variant that will be set as default. + """ + variantId: ID! + ): ProductVariantSetDefault + + """ + Creates/Updates translations for Product Variant. + """ + productVariantTranslate( + """ + Product Variant ID. + """ + id: ID! + input: NameTranslationInput! + + """ + Translation language code. + """ + languageCode: LanguageCodeEnum! + ): ProductVariantTranslate + + """ + Manage product variant prices in channels. + """ + productVariantChannelListingUpdate( + """ + ID of a product variant to update. + """ + id: ID! + + """ + ('List of fields required to create or upgrade product variant ', 'channel listings.') + """ + input: [ProductVariantChannelListingAddInput!]! + ): ProductVariantChannelListingUpdate + + """ + Reorder product variant attribute values. + """ + productVariantReorderAttributeValues( + """ + ID of an attribute. + """ + attributeId: ID! + + """ + The list of reordering operations for given attribute values. + """ + moves: [ReorderInput]! + + """ + ID of a product variant. + """ + variantId: ID! + ): ProductVariantReorderAttributeValues + + """ + Assign an media to a product variant. + """ + variantMediaAssign( + """ + ID of a product media to assign to a variant. + """ + mediaId: ID! + + """ + ID of a product variant. + """ + variantId: ID! + ): VariantMediaAssign + + """ + Unassign an media from a product variant. + """ + variantMediaUnassign( + """ + ID of a product media to unassign from a variant. + """ + mediaId: ID! + + """ + ID of a product variant. + """ + variantId: ID! + ): VariantMediaUnassign + + """ + Captures the authorized payment amount. + """ + paymentCapture( + """ + Transaction amount. + """ + amount: PositiveDecimal + + """ + Payment ID. + """ + paymentId: ID! + ): PaymentCapture + + """ + Refunds the captured payment amount. + """ + paymentRefund( + """ + Transaction amount. + """ + amount: PositiveDecimal + + """ + Payment ID. + """ + paymentId: ID! + ): PaymentRefund + + """ + Voids the authorized payment. + """ + paymentVoid( + """ + Payment ID. + """ + paymentId: ID! + ): PaymentVoid + + """ + Initializes payment process when it is required by gateway. + """ + paymentInitialize( + """ + A gateway name used to initialize the payment. + """ + gateway: String! + + """ + Client-side generated data required to initialize the payment. + """ + paymentData: JSONString + ): PaymentInitialize + + """ + Creates a new page. + """ + pageCreate( + """ + Fields required to create a page. + """ + input: PageCreateInput! + ): PageCreate + + """ + Deletes a page. + """ + pageDelete( + """ + ID of a page to delete. + """ + id: ID! + ): PageDelete + + """ + Deletes pages. + """ + pageBulkDelete( + """ + List of page IDs to delete. + """ + ids: [ID]! + ): PageBulkDelete + + """ + Publish pages. + """ + pageBulkPublish( + """ + List of page IDs to (un)publish. + """ + ids: [ID]! + + """ + Determine if pages will be published or not. + """ + isPublished: Boolean! + ): PageBulkPublish + + """ + Updates an existing page. + """ + pageUpdate( + """ + ID of a page to update. + """ + id: ID! + + """ + Fields required to update a page. + """ + input: PageInput! + ): PageUpdate + + """ + Creates/Updates translations for Page. + """ + pageTranslate( + """ + Page ID. + """ + id: ID! + input: PageTranslationInput! + + """ + Translation language code. + """ + languageCode: LanguageCodeEnum! + ): PageTranslate + + """ + Create a new page type. + """ + pageTypeCreate( + """ + Fields required to create page type. + """ + input: PageTypeCreateInput! + ): PageTypeCreate + + """ + Update page type. + """ + pageTypeUpdate( + """ + ID of the page type to update. + """ + id: ID + + """ + Fields required to update page type. + """ + input: PageTypeUpdateInput! + ): PageTypeUpdate + + """ + Delete a page type. + """ + pageTypeDelete( + """ + ID of the page type to delete. + """ + id: ID! + ): PageTypeDelete + + """ + Delete page types. + """ + pageTypeBulkDelete( + """ + List of page type IDs to delete + """ + ids: [ID!]! + ): PageTypeBulkDelete + + """ + Assign attributes to a given page type. + """ + pageAttributeAssign( + """ + The IDs of the attributes to assign. + """ + attributeIds: [ID!]! + + """ + ID of the page type to assign the attributes into. + """ + pageTypeId: ID! + ): PageAttributeAssign + + """ + Unassign attributes from a given page type. + """ + pageAttributeUnassign( + """ + The IDs of the attributes to unassign. + """ + attributeIds: [ID!]! + + """ + ID of the page type from which the attributes should be unassign. + """ + pageTypeId: ID! + ): PageAttributeUnassign + + """ + Reorder the attributes of a page type. + """ + pageTypeReorderAttributes( + """ + The list of attribute reordering operations. + """ + moves: [ReorderInput!]! + + """ + ID of a page type. + """ + pageTypeId: ID! + ): PageTypeReorderAttributes + + """ + Reorder page attribute values. + """ + pageReorderAttributeValues( + """ + ID of an attribute. + """ + attributeId: ID! + + """ + The list of reordering operations for given attribute values. + """ + moves: [ReorderInput]! + + """ + ID of a page. + """ + pageId: ID! + ): PageReorderAttributeValues + + """ + Completes creating an order. + """ + draftOrderComplete( + """ + ID of the order that will be completed. + """ + id: ID! + ): DraftOrderComplete + + """ + Creates a new draft order. + """ + draftOrderCreate( + """ + Fields required to create an order. + """ + input: DraftOrderCreateInput! + ): DraftOrderCreate + + """ + Deletes a draft order. + """ + draftOrderDelete( + """ + ID of a draft order to delete. + """ + id: ID! + ): DraftOrderDelete + + """ + Deletes draft orders. + """ + draftOrderBulkDelete( + """ + List of draft order IDs to delete. + """ + ids: [ID]! + ): DraftOrderBulkDelete + + """ + Deletes order lines. + """ + draftOrderLinesBulkDelete( + """ + List of order lines IDs to delete. + """ + ids: [ID]! + ): DraftOrderLinesBulkDelete + + """ + Updates a draft order. + """ + draftOrderUpdate( + """ + ID of a draft order to update. + """ + id: ID! + + """ + Fields required to update an order. + """ + input: DraftOrderInput! + ): DraftOrderUpdate + + """ + Adds note to the order. + """ + orderAddNote( + """ + ID of the order to add a note for. + """ + order: ID! + + """ + Fields required to create a note for the order. + """ + input: OrderAddNoteInput! + ): OrderAddNote + + """ + Cancel an order. + """ + orderCancel( + """ + ID of the order to cancel. + """ + id: ID! + ): OrderCancel + + """ + Capture an order. + """ + orderCapture( + """ + Amount of money to capture. + """ + amount: PositiveDecimal! + + """ + ID of the order to capture. + """ + id: ID! + ): OrderCapture + + """ + Confirms an unconfirmed order by changing status to unfulfilled. + """ + orderConfirm( + """ + ID of an order to confirm. + """ + id: ID! + ): OrderConfirm + + """ + Creates new fulfillments for an order. + """ + orderFulfill( + """ + Fields required to create an fulfillment. + """ + input: OrderFulfillInput! + + """ + ID of the order to be fulfilled. + """ + order: ID + ): OrderFulfill + + """ + Cancels existing fulfillment and optionally restocks items. + """ + orderFulfillmentCancel( + """ + ID of an fulfillment to cancel. + """ + id: ID! + + """ + Fields required to cancel an fulfillment. + """ + input: FulfillmentCancelInput! + ): FulfillmentCancel + + """ + Updates a fulfillment for an order. + """ + orderFulfillmentUpdateTracking( + """ + ID of an fulfillment to update. + """ + id: ID! + + """ + Fields required to update an fulfillment. + """ + input: FulfillmentUpdateTrackingInput! + ): FulfillmentUpdateTracking + + """ + Refund products. + """ + orderFulfillmentRefundProducts( + """ + Fields required to create an refund fulfillment. + """ + input: OrderRefundProductsInput! + + """ + ID of the order to be refunded. + """ + order: ID! + ): FulfillmentRefundProducts + + """ + Return products. + """ + orderFulfillmentReturnProducts( + """ + Fields required to return products. + """ + input: OrderReturnProductsInput! + + """ + ID of the order to be returned. + """ + order: ID! + ): FulfillmentReturnProducts + + """ + Create order lines for an order. + """ + orderLinesCreate( + """ + ID of the order to add the lines to. + """ + id: ID! + + """ + Fields required to add order lines. + """ + input: [OrderLineCreateInput]! + ): OrderLinesCreate + + """ + Deletes an order line from an order. + """ + orderLineDelete( + """ + ID of the order line to delete. + """ + id: ID! + ): OrderLineDelete + + """ + Updates an order line of an order. + """ + orderLineUpdate( + """ + ID of the order line to update. + """ + id: ID! + + """ + Fields required to update an order line. + """ + input: OrderLineInput! + ): OrderLineUpdate + + """ + Adds discount to the order. + """ + orderDiscountAdd( + """ + Fields required to create a discount for the order. + """ + input: OrderDiscountCommonInput! + + """ + ID of an order to discount. + """ + orderId: ID! + ): OrderDiscountAdd + + """ + Update discount for the order. + """ + orderDiscountUpdate( + """ + ID of a discount to update. + """ + discountId: ID! + + """ + Fields required to update a discount for the order. + """ + input: OrderDiscountCommonInput! + ): OrderDiscountUpdate + + """ + Remove discount from the order. + """ + orderDiscountDelete( + """ + ID of a discount to remove. + """ + discountId: ID! + ): OrderDiscountDelete + + """ + Update discount for the order line. + """ + orderLineDiscountUpdate( + """ + Fields required to update price for the order line. + """ + input: OrderDiscountCommonInput! + + """ + ID of a order line to update price + """ + orderLineId: ID! + ): OrderLineDiscountUpdate + + """ + Remove discount applied to the order line. + """ + orderLineDiscountRemove( + """ + ID of a order line to remove its discount + """ + orderLineId: ID! + ): OrderLineDiscountRemove + + """ + Mark order as manually paid. + """ + orderMarkAsPaid( + """ + ID of the order to mark paid. + """ + id: ID! + + """ + The external transaction reference. + """ + transactionReference: String + ): OrderMarkAsPaid + + """ + Refund an order. + """ + orderRefund( + """ + Amount of money to refund. + """ + amount: PositiveDecimal! + + """ + ID of the order to refund. + """ + id: ID! + ): OrderRefund + + """ + Updates an order. + """ + orderUpdate( + """ + ID of an order to update. + """ + id: ID! + + """ + Fields required to update an order. + """ + input: OrderUpdateInput! + ): OrderUpdate + + """ + Updates a shipping method of the order. + """ + orderUpdateShipping( + """ + ID of the order to update a shipping method. + """ + order: ID! + + """ + Fields required to change shipping method of the order. + """ + input: OrderUpdateShippingInput + ): OrderUpdateShipping + + """ + Void an order. + """ + orderVoid( + """ + ID of the order to void. + """ + id: ID! + ): OrderVoid + + """ + Cancels orders. + """ + orderBulkCancel( + """ + List of orders IDs to cancel. + """ + ids: [ID]! + ): OrderBulkCancel + + """ + Delete metadata of an object. + """ + deleteMetadata( + """ + ID of an object to update. + """ + id: ID! + + """ + Metadata keys to delete. + """ + keys: [String!]! + ): DeleteMetadata + + """ + Delete object's private metadata. + """ + deletePrivateMetadata( + """ + ID of an object to update. + """ + id: ID! + + """ + Metadata keys to delete. + """ + keys: [String!]! + ): DeletePrivateMetadata + + """ + Updates metadata of an object. + """ + updateMetadata( + """ + ID of an object to update. + """ + id: ID! + + """ + Fields required to update the object's metadata. + """ + input: [MetadataInput!]! + ): UpdateMetadata + + """ + Updates private metadata of an object. + """ + updatePrivateMetadata( + """ + ID of an object to update. + """ + id: ID! + + """ + Fields required to update the object's metadata. + """ + input: [MetadataInput!]! + ): UpdatePrivateMetadata + + """ + Assigns storefront's navigation menus. + """ + assignNavigation( + """ + ID of the menu. + """ + menu: ID + + """ + Type of the navigation bar to assign the menu to. + """ + navigationType: NavigationType! + ): AssignNavigation + + """ + Creates a new Menu. + """ + menuCreate( + """ + Fields required to create a menu. + """ + input: MenuCreateInput! + ): MenuCreate + + """ + Deletes a menu. + """ + menuDelete( + """ + ID of a menu to delete. + """ + id: ID! + ): MenuDelete + + """ + Deletes menus. + """ + menuBulkDelete( + """ + List of menu IDs to delete. + """ + ids: [ID]! + ): MenuBulkDelete + + """ + Updates a menu. + """ + menuUpdate( + """ + ID of a menu to update. + """ + id: ID! + + """ + Fields required to update a menu. + """ + input: MenuInput! + ): MenuUpdate + + """ + Creates a new menu item. + """ + menuItemCreate( + """ + Fields required to update a menu item. Only one of `url`, `category`, `page`, `collection` is allowed per item. + """ + input: MenuItemCreateInput! + ): MenuItemCreate + + """ + Deletes a menu item. + """ + menuItemDelete( + """ + ID of a menu item to delete. + """ + id: ID! + ): MenuItemDelete + + """ + Deletes menu items. + """ + menuItemBulkDelete( + """ + List of menu item IDs to delete. + """ + ids: [ID]! + ): MenuItemBulkDelete + + """ + Updates a menu item. + """ + menuItemUpdate( + """ + ID of a menu item to update. + """ + id: ID! + + """ + Fields required to update a menu item. Only one of `url`, `category`, `page`, `collection` is allowed per item. + """ + input: MenuItemInput! + ): MenuItemUpdate + + """ + Creates/Updates translations for Menu Item. + """ + menuItemTranslate( + """ + Menu Item ID. + """ + id: ID! + input: NameTranslationInput! + + """ + Translation language code. + """ + languageCode: LanguageCodeEnum! + ): MenuItemTranslate + + """ + Moves items of menus. + """ + menuItemMove( + """ + ID of the menu. + """ + menu: ID! + + """ + The menu position data. + """ + moves: [MenuItemMoveInput]! + ): MenuItemMove + + """ + Request an invoice for the order using plugin. + """ + invoiceRequest( + """ + Invoice number, if not provided it will be generated. + """ + number: String + + """ + ID of the order related to invoice. + """ + orderId: ID! + ): InvoiceRequest + + """ + Requests deletion of an invoice. + """ + invoiceRequestDelete( + """ + ID of an invoice to request the deletion. + """ + id: ID! + ): InvoiceRequestDelete + + """ + Creates a ready to send invoice. + """ + invoiceCreate( + """ + Fields required when creating an invoice. + """ + input: InvoiceCreateInput! + + """ + ID of the order related to invoice. + """ + orderId: ID! + ): InvoiceCreate + + """ + Deletes an invoice. + """ + invoiceDelete( + """ + ID of an invoice to delete. + """ + id: ID! + ): InvoiceDelete + + """ + Updates an invoice. + """ + invoiceUpdate( + """ + ID of an invoice to update. + """ + id: ID! + + """ + Fields to use when updating an invoice. + """ + input: UpdateInvoiceInput! + ): InvoiceUpdate + + """ + Send an invoice notification to the customer. + """ + invoiceSendNotification( + """ + ID of an invoice to be sent. + """ + id: ID! + ): InvoiceSendNotification + + """ + Activate a gift card. + """ + giftCardActivate( + """ + ID of a gift card to activate. + """ + id: ID! + ): GiftCardActivate + + """ + Creates a new gift card. + """ + giftCardCreate( + """ + Fields required to create a gift card. + """ + input: GiftCardCreateInput! + ): GiftCardCreate + + """ + Deactivate a gift card. + """ + giftCardDeactivate( + """ + ID of a gift card to deactivate. + """ + id: ID! + ): GiftCardDeactivate + + """ + Update a gift card. + """ + giftCardUpdate( + """ + ID of a gift card to update. + """ + id: ID! + + """ + Fields required to update a gift card. + """ + input: GiftCardUpdateInput! + ): GiftCardUpdate + + """ + Update plugin configuration. + """ + pluginUpdate( + """ + ID of plugin to update. + """ + id: ID! + + """ + Fields required to update a plugin configuration. + """ + input: PluginUpdateInput! + ): PluginUpdate + + """ + Creates a new sale. + """ + saleCreate( + """ + Fields required to create a sale. + """ + input: SaleInput! + ): SaleCreate + + """ + Deletes a sale. + """ + saleDelete( + """ + ID of a sale to delete. + """ + id: ID! + ): SaleDelete + + """ + Deletes sales. + """ + saleBulkDelete( + """ + List of sale IDs to delete. + """ + ids: [ID]! + ): SaleBulkDelete + + """ + Updates a sale. + """ + saleUpdate( + """ + ID of a sale to update. + """ + id: ID! + + """ + Fields required to update a sale. + """ + input: SaleInput! + ): SaleUpdate + + """ + Adds products, categories, collections to a voucher. + """ + saleCataloguesAdd( + """ + ID of a sale. + """ + id: ID! + + """ + Fields required to modify catalogue IDs of sale. + """ + input: CatalogueInput! + ): SaleAddCatalogues + + """ + Removes products, categories, collections from a sale. + """ + saleCataloguesRemove( + """ + ID of a sale. + """ + id: ID! + + """ + Fields required to modify catalogue IDs of sale. + """ + input: CatalogueInput! + ): SaleRemoveCatalogues + + """ + Creates/updates translations for a sale. + """ + saleTranslate( + """ + Voucher ID. + """ + id: ID! + input: NameTranslationInput! + + """ + Translation language code. + """ + languageCode: LanguageCodeEnum! + ): SaleTranslate + + """ + Manage sale's availability in channels. + """ + saleChannelListingUpdate( + """ + ID of a sale to update. + """ + id: ID! + + """ + Fields required to update sale channel listings. + """ + input: SaleChannelListingInput! + ): SaleChannelListingUpdate + + """ + Creates a new voucher. + """ + voucherCreate( + """ + Fields required to create a voucher. + """ + input: VoucherInput! + ): VoucherCreate + + """ + Deletes a voucher. + """ + voucherDelete( + """ + ID of a voucher to delete. + """ + id: ID! + ): VoucherDelete + + """ + Deletes vouchers. + """ + voucherBulkDelete( + """ + List of voucher IDs to delete. + """ + ids: [ID]! + ): VoucherBulkDelete + + """ + Updates a voucher. + """ + voucherUpdate( + """ + ID of a voucher to update. + """ + id: ID! + + """ + Fields required to update a voucher. + """ + input: VoucherInput! + ): VoucherUpdate + + """ + Adds products, categories, collections to a voucher. + """ + voucherCataloguesAdd( + """ + ID of a voucher. + """ + id: ID! + + """ + Fields required to modify catalogue IDs of voucher. + """ + input: CatalogueInput! + ): VoucherAddCatalogues + + """ + Removes products, categories, collections from a voucher. + """ + voucherCataloguesRemove( + """ + ID of a voucher. + """ + id: ID! + + """ + Fields required to modify catalogue IDs of voucher. + """ + input: CatalogueInput! + ): VoucherRemoveCatalogues + + """ + Creates/Updates translations for Voucher. + """ + voucherTranslate( + """ + Voucher ID. + """ + id: ID! + input: NameTranslationInput! + + """ + Translation language code. + """ + languageCode: LanguageCodeEnum! + ): VoucherTranslate + + """ + Manage voucher's availability in channels. + """ + voucherChannelListingUpdate( + """ + ID of a voucher to update. + """ + id: ID! + + """ + Fields required to update voucher channel listings. + """ + input: VoucherChannelListingInput! + ): VoucherChannelListingUpdate + + """ + Export products to csv file. + """ + exportProducts( + """ + Fields required to export product data + """ + input: ExportProductsInput! + ): ExportProducts + + """ + Upload a file. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec + """ + fileUpload( + """ + Represents a file in a multipart request. + """ + file: Upload! + ): FileUpload + + """ + Adds a gift card or a voucher to a checkout. + """ + checkoutAddPromoCode( + """ + Checkout ID. + """ + checkoutId: ID! + + """ + Gift card code or voucher code. + """ + promoCode: String! + ): CheckoutAddPromoCode + + """ + Update billing address in the existing checkout. + """ + checkoutBillingAddressUpdate( + """ + The billing address of the checkout. + """ + billingAddress: AddressInput! + + """ + ID of the checkout. + """ + checkoutId: ID! + ): CheckoutBillingAddressUpdate + + """ + Completes the checkout. As a result a new order is created and a payment charge is made. This action requires a successful payment before it can be performed. In case additional confirmation step as 3D secure is required confirmationNeeded flag will be set to True and no order created until payment is confirmed with second call of this mutation. + """ + checkoutComplete( + """ + Checkout ID. + """ + checkoutId: ID! + + """ + Client-side generated data required to finalize the payment. + """ + paymentData: JSONString + + """ + URL of a view where users should be redirected to see the order details. URL in RFC 1808 format. + """ + redirectUrl: String + + """ + Determines whether to store the payment source for future usage. + """ + storeSource: Boolean = false + ): CheckoutComplete + + """ + Create a new checkout. + """ + checkoutCreate( + """ + Fields required to create checkout. + """ + input: CheckoutCreateInput! + ): CheckoutCreate + + """ + Sets the customer as the owner of the checkout. + """ + checkoutCustomerAttach( + """ + ID of the checkout. + """ + checkoutId: ID! + + """ + [Deprecated] The ID of the customer. To identify a customer you should authenticate with JWT. This field will be removed after 2020-07-31. + """ + customerId: ID + ): CheckoutCustomerAttach + + """ + Removes the user assigned as the owner of the checkout. + """ + checkoutCustomerDetach( + """ + Checkout ID. + """ + checkoutId: ID! + ): CheckoutCustomerDetach + + """ + Updates email address in the existing checkout object. + """ + checkoutEmailUpdate( + """ + Checkout ID. + """ + checkoutId: ID + + """ + email. + """ + email: String! + ): CheckoutEmailUpdate + + """ + Deletes a CheckoutLine. + """ + checkoutLineDelete( + """ + The ID of the checkout. + """ + checkoutId: ID! + + """ + ID of the checkout line to delete. + """ + lineId: ID + ): CheckoutLineDelete + + """ + Adds a checkout line to the existing checkout. + """ + checkoutLinesAdd( + """ + The ID of the checkout. + """ + checkoutId: ID! + + """ + A list of checkout lines, each containing information about an item in the checkout. + """ + lines: [CheckoutLineInput]! + ): CheckoutLinesAdd + + """ + Updates checkout line in the existing checkout. + """ + checkoutLinesUpdate( + """ + The ID of the checkout. + """ + checkoutId: ID! + + """ + A list of checkout lines, each containing information about an item in the checkout. + """ + lines: [CheckoutLineInput]! + ): CheckoutLinesUpdate + + """ + Remove a gift card or a voucher from a checkout. + """ + checkoutRemovePromoCode( + """ + Checkout ID. + """ + checkoutId: ID! + + """ + Gift card code or voucher code. + """ + promoCode: String! + ): CheckoutRemovePromoCode + + """ + Create a new payment for given checkout. + """ + checkoutPaymentCreate( + """ + Checkout ID. + """ + checkoutId: ID! + + """ + Data required to create a new payment. + """ + input: PaymentInput! + ): CheckoutPaymentCreate + + """ + Update shipping address in the existing checkout. + """ + checkoutShippingAddressUpdate( + """ + ID of the checkout. + """ + checkoutId: ID! + + """ + The mailing address to where the checkout will be shipped. + """ + shippingAddress: AddressInput! + ): CheckoutShippingAddressUpdate + + """ + Updates the shipping address of the checkout. + """ + checkoutShippingMethodUpdate( + """ + Checkout ID. + """ + checkoutId: ID + + """ + Shipping method. + """ + shippingMethodId: ID! + ): CheckoutShippingMethodUpdate + + """ + Update language code in the existing checkout. + """ + checkoutLanguageCodeUpdate( + """ + ID of the checkout. + """ + checkoutId: ID! + + """ + New language code. + """ + languageCode: LanguageCodeEnum! + ): CheckoutLanguageCodeUpdate + + """ + Creates new channel. + """ + channelCreate( + """ + Fields required to create channel. + """ + input: ChannelCreateInput! + ): ChannelCreate + + """ + Update a channel. + """ + channelUpdate( + """ + ID of a channel to update. + """ + id: ID! + + """ + Fields required to update a channel. + """ + input: ChannelUpdateInput! + ): ChannelUpdate + + """ + Delete a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. + """ + channelDelete( + """ + ID of a channel to delete. + """ + id: ID! + + """ + Fields required to delete a channel. + """ + input: ChannelDeleteInput + ): ChannelDelete + + """ + Activate a channel. + """ + channelActivate( + """ + ID of the channel to activate. + """ + id: ID! + ): ChannelActivate + + """ + Deactivate a channel. + """ + channelDeactivate( + """ + ID of the channel to deactivate. + """ + id: ID! + ): ChannelDeactivate + + """ + Creates an attribute. + """ + attributeCreate( + """ + Fields required to create an attribute. + """ + input: AttributeCreateInput! + ): AttributeCreate + + """ + Deletes an attribute. + """ + attributeDelete( + """ + ID of an attribute to delete. + """ + id: ID! + ): AttributeDelete + + """ + Updates attribute. + """ + attributeUpdate( + """ + ID of an attribute to update. + """ + id: ID! + + """ + Fields required to update an attribute. + """ + input: AttributeUpdateInput! + ): AttributeUpdate + + """ + Creates/Updates translations for attribute. + """ + attributeTranslate( + """ + Attribute ID. + """ + id: ID! + input: NameTranslationInput! + + """ + Translation language code. + """ + languageCode: LanguageCodeEnum! + ): AttributeTranslate + + """ + Deletes attributes. + """ + attributeBulkDelete( + """ + List of attribute IDs to delete. + """ + ids: [ID]! + ): AttributeBulkDelete + + """ + Deletes values of attributes. + """ + attributeValueBulkDelete( + """ + List of attribute value IDs to delete. + """ + ids: [ID]! + ): AttributeValueBulkDelete + + """ + Creates a value for an attribute. + """ + attributeValueCreate( + """ + Attribute to which value will be assigned. + """ + attribute: ID! + + """ + Fields required to create an AttributeValue. + """ + input: AttributeValueCreateInput! + ): AttributeValueCreate + + """ + Deletes a value of an attribute. + """ + attributeValueDelete( + """ + ID of a value to delete. + """ + id: ID! + ): AttributeValueDelete + + """ + Updates value of an attribute. + """ + attributeValueUpdate( + """ + ID of an AttributeValue to update. + """ + id: ID! + + """ + Fields required to update an AttributeValue. + """ + input: AttributeValueCreateInput! + ): AttributeValueUpdate + + """ + Creates/Updates translations for attribute value. + """ + attributeValueTranslate( + """ + Attribute Value ID. + """ + id: ID! + input: AttributeValueTranslationInput! + + """ + Translation language code. + """ + languageCode: LanguageCodeEnum! + ): AttributeValueTranslate + + """ + Reorder the values of an attribute. + """ + attributeReorderValues( + """ + ID of an attribute. + """ + attributeId: ID! + + """ + The list of reordering operations for given attribute values. + """ + moves: [ReorderInput]! + ): AttributeReorderValues + + """ + Creates a new app. + """ + appCreate( + """ + Fields required to create a new app. + """ + input: AppInput! + ): AppCreate + + """ + Updates an existing app. + """ + appUpdate( + """ + ID of an app to update. + """ + id: ID! + + """ + Fields required to update an existing app. + """ + input: AppInput! + ): AppUpdate + + """ + Deletes an app. + """ + appDelete( + """ + ID of an app to delete. + """ + id: ID! + ): AppDelete + + """ + Creates a new token. + """ + appTokenCreate( + """ + Fields required to create a new auth token. + """ + input: AppTokenInput! + ): AppTokenCreate + + """ + Deletes an authentication token assigned to app. + """ + appTokenDelete( + """ + ID of an auth token to delete. + """ + id: ID! + ): AppTokenDelete + + """ + Verify provided app token. + """ + appTokenVerify( + """ + App token to verify. + """ + token: String! + ): AppTokenVerify + + """ + Install new app by using app manifest. + """ + appInstall( + """ + Fields required to install a new app. + """ + input: AppInstallInput! + ): AppInstall + + """ + Retry failed installation of new app. + """ + appRetryInstall( + """ + Determine if app will be set active or not. + """ + activateAfterInstallation: Boolean = true + + """ + ID of failed installation. + """ + id: ID! + ): AppRetryInstall + + """ + Delete failed installation. + """ + appDeleteFailedInstallation( + """ + ID of failed installation to delete. + """ + id: ID! + ): AppDeleteFailedInstallation + + """ + Fetch and validate manifest. + """ + appFetchManifest(manifestUrl: String!): AppFetchManifest + + """ + Activate the app. + """ + appActivate( + """ + ID of app to activate. + """ + id: ID! + ): AppActivate + + """ + Deactivate the app. + """ + appDeactivate( + """ + ID of app to deactivate. + """ + id: ID! + ): AppDeactivate + + """ + Create JWT token. + """ + tokenCreate( + """ + Email of a user. + """ + email: String! + + """ + Password of a user. + """ + password: String! + ): CreateToken + + """ + Refresh JWT token. Mutation tries to take refreshToken from the input.If it fails it will try to take refreshToken from the http-only cookie -refreshToken. csrfToken is required when refreshToken is provided as a cookie. + """ + tokenRefresh( + """ + CSRF token required to refresh token. This argument is required when refreshToken is provided as a cookie. + """ + csrfToken: String + + """ + Refresh token. + """ + refreshToken: String + ): RefreshToken + + """ + Verify JWT token. + """ + tokenVerify( + """ + JWT token to validate. + """ + token: String! + ): VerifyToken + + """ + Deactivate all JWT tokens of the currently authenticated user. + """ + tokensDeactivateAll: DeactivateAllUserTokens + + """ + Prepare external authentication url for user by custom plugin. + """ + externalAuthenticationUrl( + """ + The data required by plugin to create external authentication url. + """ + input: JSONString! + + """ + The ID of the authentication plugin. + """ + pluginId: String! + ): ExternalAuthenticationUrl + + """ + Obtain external access tokens for user by custom plugin. + """ + externalObtainAccessTokens( + """ + The data required by plugin to create authentication data. + """ + input: JSONString! + + """ + The ID of the authentication plugin. + """ + pluginId: String! + ): ExternalObtainAccessTokens + + """ + Refresh user's access by custom plugin. + """ + externalRefresh( + """ + The data required by plugin to proceed the refresh process. + """ + input: JSONString! + + """ + The ID of the authentication plugin. + """ + pluginId: String! + ): ExternalRefresh + + """ + Logout user by custom plugin. + """ + externalLogout( + """ + The data required by plugin to proceed the logout process. + """ + input: JSONString! + + """ + The ID of the authentication plugin. + """ + pluginId: String! + ): ExternalLogout + + """ + Verify external authentication data by plugin. + """ + externalVerify( + """ + The data required by plugin to proceed the verification. + """ + input: JSONString! + + """ + The ID of the authentication plugin. + """ + pluginId: String! + ): ExternalVerify + + """ + Sends an email with the account password modification link. + """ + requestPasswordReset( + """ + Email of the user that will be used for password recovery. + """ + email: String! + + """ + URL of a view where users should be redirected to reset the password. URL in RFC 1808 format. + """ + redirectUrl: String! + ): RequestPasswordReset + + """ + Confirm user account with token sent by email during registration. + """ + confirmAccount( + """ + E-mail of the user performing account confirmation. + """ + email: String! + + """ + A one-time token required to confirm the account. + """ + token: String! + ): ConfirmAccount + + """ + Sets the user's password from the token sent by email using the RequestPasswordReset mutation. + """ + setPassword( + """ + Email of a user. + """ + email: String! + + """ + Password of a user. + """ + password: String! + + """ + A one-time token required to set the password. + """ + token: String! + ): SetPassword + + """ + Change the password of the logged in user. + """ + passwordChange( + """ + New user password. + """ + newPassword: String! + + """ + Current user password. + """ + oldPassword: String! + ): PasswordChange + + """ + Request email change of the logged in user. + """ + requestEmailChange( + """ + New user email. + """ + newEmail: String! + + """ + User password. + """ + password: String! + + """ + URL of a view where users should be redirected to update the email address. URL in RFC 1808 format. + """ + redirectUrl: String! + ): RequestEmailChange + + """ + Confirm the email change of the logged-in user. + """ + confirmEmailChange( + """ + A one-time token required to change the email. + """ + token: String! + ): ConfirmEmailChange + + """ + Create a new address for the customer. + """ + accountAddressCreate( + """ + Fields required to create address. + """ + input: AddressInput! + + """ + A type of address. If provided, the new address will be automatically assigned as the customer's default address of that type. + """ + type: AddressTypeEnum + ): AccountAddressCreate + + """ + Updates an address of the logged-in user. + """ + accountAddressUpdate( + """ + ID of the address to update. + """ + id: ID! + + """ + Fields required to update the address. + """ + input: AddressInput! + ): AccountAddressUpdate + + """ + Delete an address of the logged-in user. + """ + accountAddressDelete( + """ + ID of the address to delete. + """ + id: ID! + ): AccountAddressDelete + + """ + Sets a default address for the authenticated user. + """ + accountSetDefaultAddress( + """ + ID of the address to set as default. + """ + id: ID! + + """ + The type of address. + """ + type: AddressTypeEnum! + ): AccountSetDefaultAddress + + """ + Register a new user. + """ + accountRegister( + """ + Fields required to create a user. + """ + input: AccountRegisterInput! + ): AccountRegister + + """ + Updates the account of the logged-in user. + """ + accountUpdate( + """ + Fields required to update the account of the logged-in user. + """ + input: AccountInput! + ): AccountUpdate + + """ + Sends an email with the account removal link for the logged-in user. + """ + accountRequestDeletion( + """ + URL of a view where users should be redirected to delete their account. URL in RFC 1808 format. + """ + redirectUrl: String! + ): AccountRequestDeletion + + """ + Remove user account. + """ + accountDelete( + """ + A one-time token required to remove account. Sent by email using AccountRequestDeletion mutation. + """ + token: String! + ): AccountDelete + + """ + Creates user address. + """ + addressCreate( + """ + Fields required to create address. + """ + input: AddressInput! + + """ + ID of a user to create address for. + """ + userId: ID! + ): AddressCreate + + """ + Updates an address. + """ + addressUpdate( + """ + ID of the address to update. + """ + id: ID! + + """ + Fields required to update the address. + """ + input: AddressInput! + ): AddressUpdate + + """ + Deletes an address. + """ + addressDelete( + """ + ID of the address to delete. + """ + id: ID! + ): AddressDelete + + """ + Sets a default address for the given user. + """ + addressSetDefault( + """ + ID of the address. + """ + addressId: ID! + + """ + The type of address. + """ + type: AddressTypeEnum! + + """ + ID of the user to change the address for. + """ + userId: ID! + ): AddressSetDefault + + """ + Creates a new customer. + """ + customerCreate( + """ + Fields required to create a customer. + """ + input: UserCreateInput! + ): CustomerCreate + + """ + Updates an existing customer. + """ + customerUpdate( + """ + ID of a customer to update. + """ + id: ID! + + """ + Fields required to update a customer. + """ + input: CustomerInput! + ): CustomerUpdate + + """ + Deletes a customer. + """ + customerDelete( + """ + ID of a customer to delete. + """ + id: ID! + ): CustomerDelete + + """ + Deletes customers. + """ + customerBulkDelete( + """ + List of user IDs to delete. + """ + ids: [ID]! + ): CustomerBulkDelete + + """ + Creates a new staff user. + """ + staffCreate( + """ + Fields required to create a staff user. + """ + input: StaffCreateInput! + ): StaffCreate + + """ + Updates an existing staff user. + """ + staffUpdate( + """ + ID of a staff user to update. + """ + id: ID! + + """ + Fields required to update a staff user. + """ + input: StaffUpdateInput! + ): StaffUpdate + + """ + Deletes a staff user. + """ + staffDelete( + """ + ID of a staff user to delete. + """ + id: ID! + ): StaffDelete + + """ + Deletes staff users. + """ + staffBulkDelete( + """ + List of user IDs to delete. + """ + ids: [ID]! + ): StaffBulkDelete + + """ + Create a user avatar. Only for staff members. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec + """ + userAvatarUpdate( + """ + Represents an image file in a multipart request. + """ + image: Upload! + ): UserAvatarUpdate + + """ + Deletes a user avatar. Only for staff members. + """ + userAvatarDelete: UserAvatarDelete + + """ + Activate or deactivate users. + """ + userBulkSetActive( + """ + List of user IDs to (de)activate). + """ + ids: [ID]! + + """ + Determine if users will be set active or not. + """ + isActive: Boolean! + ): UserBulkSetActive + + """ + Create new permission group. + """ + permissionGroupCreate( + """ + Input fields to create permission group. + """ + input: PermissionGroupCreateInput! + ): PermissionGroupCreate + + """ + Update permission group. + """ + permissionGroupUpdate( + """ + ID of the group to update. + """ + id: ID! + + """ + Input fields to create permission group. + """ + input: PermissionGroupUpdateInput! + ): PermissionGroupUpdate + + """ + Delete permission group. + """ + permissionGroupDelete( + """ + ID of the group to delete. + """ + id: ID! + ): PermissionGroupDelete } """ -Represents a source for a Shopify hosted video. +Creates a new webhook subscription. """ -type VideoSource { +type WebhookCreate { """ - The format of the video source. + List of errors that occurred executing the mutation. """ - format: String! + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + webhookErrors: [WebhookError!]! + webhook: Webhook +} + +""" +Represents an error in the input of a mutation. +""" +type Error { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String """ - The height of the video. + The error message. """ - height: Int! + message: String +} + +type WebhookError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String """ - The video MIME type. + The error message. """ - mimeType: String! + message: String """ - The URL of the video. + The error code. + """ + code: WebhookErrorCode! +} + +""" +An enumeration. +""" +enum WebhookErrorCode { + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE +} + +input WebhookCreateInput { + """ + The name of the webhook. + """ + name: String + + """ + The url to receive the payload. + """ + targetUrl: String + + """ + The events that webhook wants to subscribe. + """ + events: [WebhookEventTypeEnum] + + """ + ID of the app to which webhook belongs. + """ + app: ID + + """ + Determine if webhook will be set active or not. + """ + isActive: Boolean + + """ + The secret key used to create a hash signature with each payload. + """ + secretKey: String +} + +""" +Deletes a webhook subscription. +""" +type WebhookDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + webhookErrors: [WebhookError!]! + webhook: Webhook +} + +""" +Updates a webhook subscription. +""" +type WebhookUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + webhookErrors: [WebhookError!]! + webhook: Webhook +} + +input WebhookUpdateInput { + """ + The new name of the webhook. + """ + name: String + + """ + The url to receive the payload. + """ + targetUrl: String + + """ + The events that webhook wants to subscribe. + """ + events: [WebhookEventTypeEnum] + + """ + ID of the app to which webhook belongs. + """ + app: ID + + """ + Determine if webhook will be set active or not. + """ + isActive: Boolean + + """ + Use to create a hash signature with each payload. + """ + secretKey: String +} + +""" +Creates new warehouse. +""" +type WarehouseCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + warehouseErrors: [WarehouseError!]! + warehouse: Warehouse +} + +type WarehouseError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: WarehouseErrorCode! +} + +""" +An enumeration. +""" +enum WarehouseErrorCode { + ALREADY_EXISTS + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE +} + +input WarehouseCreateInput { + """ + Warehouse slug. + """ + slug: String + + """ + Company name. + """ + companyName: String + + """ + The email address of the warehouse. + """ + email: String + + """ + Warehouse name. + """ + name: String! + + """ + Address of the warehouse. + """ + address: WarehouseAddressInput! + + """ + Shipping zones supported by the warehouse. + """ + shippingZones: [ID] +} + +input WarehouseAddressInput { + """ + Address. + """ + streetAddress1: String! + + """ + Address. + """ + streetAddress2: String + + """ + City. + """ + city: String! + + """ + District. + """ + cityArea: String + + """ + Postal code. + """ + postalCode: String + + """ + Country. + """ + country: CountryCode! + + """ + State or province. + """ + countryArea: String + + """ + Phone number. + """ + phone: String +} + +""" +Updates given warehouse. +""" +type WarehouseUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + warehouseErrors: [WarehouseError!]! + warehouse: Warehouse +} + +input WarehouseUpdateInput { + """ + Warehouse slug. + """ + slug: String + + """ + Company name. + """ + companyName: String + + """ + The email address of the warehouse. + """ + email: String + + """ + Warehouse name. + """ + name: String + + """ + Address of the warehouse. + """ + address: WarehouseAddressInput +} + +""" +Deletes selected warehouse. +""" +type WarehouseDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + warehouseErrors: [WarehouseError!]! + warehouse: Warehouse +} + +""" +Add shipping zone to given warehouse. +""" +type WarehouseShippingZoneAssign { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + warehouseErrors: [WarehouseError!]! + warehouse: Warehouse +} + +""" +Remove shipping zone from given warehouse. +""" +type WarehouseShippingZoneUnassign { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + warehouseErrors: [WarehouseError!]! + warehouse: Warehouse +} + +""" +Creates a new staff notification recipient. +""" +type StaffNotificationRecipientCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + shopErrors: [ShopError!]! + staffNotificationRecipient: StaffNotificationRecipient +} + +type ShopError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: ShopErrorCode! +} + +""" +An enumeration. +""" +enum ShopErrorCode { + ALREADY_EXISTS + CANNOT_FETCH_TAX_RATES + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE +} + +input StaffNotificationRecipientInput { + """ + The ID of the user subscribed to email notifications.. + """ + user: ID + + """ + Email address of a user subscribed to email notifications. + """ + email: String + + """ + Determines if a notification active. + """ + active: Boolean +} + +""" +Updates a staff notification recipient. +""" +type StaffNotificationRecipientUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + shopErrors: [ShopError!]! + staffNotificationRecipient: StaffNotificationRecipient +} + +""" +Delete staff notification recipient. +""" +type StaffNotificationRecipientDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + shopErrors: [ShopError!]! + staffNotificationRecipient: StaffNotificationRecipient +} + +""" +Updates site domain of the shop. +""" +type ShopDomainUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Updated shop. + """ + shop: Shop + shopErrors: [ShopError!]! +} + +input SiteDomainInput { + """ + Domain name for shop. + """ + domain: String + + """ + Shop site name. + """ + name: String +} + +""" +Updates shop settings. +""" +type ShopSettingsUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Updated shop. + """ + shop: Shop + shopErrors: [ShopError!]! +} + +input ShopSettingsInput { + """ + Header text. + """ + headerText: String + + """ + SEO description. + """ + description: String + + """ + Include taxes in prices. + """ + includeTaxesInPrices: Boolean + + """ + Display prices with tax in store. + """ + displayGrossPrices: Boolean + + """ + Charge taxes on shipping. + """ + chargeTaxesOnShipping: Boolean + + """ + Enable inventory tracking. + """ + trackInventoryByDefault: Boolean + + """ + Default weight unit. + """ + defaultWeightUnit: WeightUnitsEnum + + """ + Enable automatic fulfillment for all digital products. + """ + automaticFulfillmentDigitalProducts: Boolean + + """ + Default number of max downloads per digital content URL. + """ + defaultDigitalMaxDownloads: Int + + """ + Default number of days which digital content URL will be valid. + """ + defaultDigitalUrlValidDays: Int + + """ + Default email sender's name. + """ + defaultMailSenderName: String + + """ + Default email sender's address. + """ + defaultMailSenderAddress: String + + """ + URL of a view where customers can set their password. + """ + customerSetPasswordUrl: String +} + +""" +Fetch tax rates. +""" +type ShopFetchTaxRates { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Updated shop. + """ + shop: Shop + shopErrors: [ShopError!]! +} + +""" +Creates/Updates translations for Shop Settings. +""" +type ShopSettingsTranslate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Updated shop. + """ + shop: Shop + translationErrors: [TranslationError!]! +} + +type TranslationError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: TranslationErrorCode! +} + +""" +An enumeration. +""" +enum TranslationErrorCode { + GRAPHQL_ERROR + NOT_FOUND + REQUIRED +} + +input ShopSettingsTranslationInput { + headerText: String + description: String +} + +""" +Update the shop's address. If the `null` value is passed, the currently selected address will be deleted. +""" +type ShopAddressUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Updated shop. + """ + shop: Shop + shopErrors: [ShopError!]! +} + +""" +Update shop order settings. +""" +type OrderSettingsUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Order settings. + """ + orderSettings: OrderSettings + orderSettingsErrors: [OrderSettingsError!]! +} + +type OrderSettingsError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: OrderSettingsErrorCode! +} + +""" +An enumeration. +""" +enum OrderSettingsErrorCode { + INVALID +} + +input OrderSettingsUpdateInput { + """ + When disabled, all new orders from checkout will be marked as unconfirmed. When enabled orders from checkout will become unfulfilled immediately. + """ + automaticallyConfirmAllNewOrders: Boolean! +} + +""" +Manage shipping method's availability in channels. +""" +type ShippingMethodChannelListingUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated shipping method instance. + """ + shippingMethod: ShippingMethod + shippingErrors: [ShippingError!]! +} + +type ShippingError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: ShippingErrorCode! + + """ + List of warehouse IDs which causes the error. + """ + warehouses: [ID!] + + """ + List of channels IDs which causes the error. + """ + channels: [ID!] +} + +""" +An enumeration. +""" +enum ShippingErrorCode { + ALREADY_EXISTS + GRAPHQL_ERROR + INVALID + MAX_LESS_THAN_MIN + NOT_FOUND + REQUIRED + UNIQUE + DUPLICATED_INPUT_ITEM +} + +input ShippingMethodChannelListingInput { + """ + List of channels to which the shipping method should be assigned. + """ + addChannels: [ShippingMethodChannelListingAddInput!] + + """ + List of channels from which the shipping method should be unassigned. + """ + removeChannels: [ID!] +} + +input ShippingMethodChannelListingAddInput { + """ + ID of a channel. + """ + channelId: ID! + + """ + Shipping price of the shipping method in this channel. + """ + price: PositiveDecimal + + """ + Minimum order price to use this shipping method. + """ + minimumOrderPrice: PositiveDecimal + + """ + Maximum order price to use this shipping method. + """ + maximumOrderPrice: PositiveDecimal +} + +""" +Creates a new shipping price. +""" +type ShippingPriceCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A shipping zone to which the shipping method belongs. + """ + shippingZone: ShippingZone + shippingMethod: ShippingMethod + shippingErrors: [ShippingError!]! +} + +input ShippingPriceInput { + """ + Name of the shipping method. + """ + name: String + + """ + Minimum order weight to use this shipping method. + """ + minimumOrderWeight: WeightScalar + + """ + Maximum order weight to use this shipping method. + """ + maximumOrderWeight: WeightScalar + + """ + Maximum number of days for delivery. + """ + maximumDeliveryDays: Int + + """ + Minimal number of days for delivery. + """ + minimumDeliveryDays: Int + + """ + Shipping type: price or weight based. + """ + type: ShippingMethodTypeEnum + + """ + Shipping zone this method belongs to. + """ + shippingZone: ID + + """ + Postal code rules to add. + """ + addPostalCodeRules: [ShippingPostalCodeRulesCreateInputRange!] + + """ + Postal code rules to delete. + """ + deletePostalCodeRules: [ID!] + + """ + Inclusion type for currently assigned postal code rules. + """ + inclusionType: PostalCodeRuleInclusionTypeEnum +} + +scalar WeightScalar + +input ShippingPostalCodeRulesCreateInputRange { + """ + Start range of the postal code. + """ + start: String! + + """ + End range of the postal code. + """ + end: String +} + +""" +Deletes a shipping price. +""" +type ShippingPriceDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A shipping method to delete. + """ + shippingMethod: ShippingMethod + + """ + A shipping zone to which the shipping method belongs. + """ + shippingZone: ShippingZone + shippingErrors: [ShippingError!]! +} + +""" +Deletes shipping prices. +""" +type ShippingPriceBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + shippingErrors: [ShippingError!]! +} + +""" +Updates a new shipping price. +""" +type ShippingPriceUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A shipping zone to which the shipping method belongs. + """ + shippingZone: ShippingZone + shippingMethod: ShippingMethod + shippingErrors: [ShippingError!]! +} + +""" +Creates/Updates translations for shipping method. +""" +type ShippingPriceTranslate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + translationErrors: [TranslationError!]! + shippingMethod: ShippingMethod +} + +input NameTranslationInput { + name: String +} + +""" +Exclude products from shipping price. +""" +type ShippingPriceExcludeProducts { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A shipping method with new list of excluded products. + """ + shippingMethod: ShippingMethod + shippingErrors: [ShippingError!]! +} + +input ShippingPriceExcludeProductsInput { + """ + List of products which will be excluded. + """ + products: [ID]! +} + +""" +Remove product from excluded list for shipping price. +""" +type ShippingPriceRemoveProductFromExclude { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A shipping method with new list of excluded products. + """ + shippingMethod: ShippingMethod + shippingErrors: [ShippingError!]! +} + +""" +Creates a new shipping zone. +""" +type ShippingZoneCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + shippingErrors: [ShippingError!]! + shippingZone: ShippingZone +} + +input ShippingZoneCreateInput { + """ + Shipping zone's name. Visible only to the staff. + """ + name: String + + """ + Description of the shipping zone. + """ + description: String + + """ + List of countries in this shipping zone. + """ + countries: [String] + + """ + Default shipping zone will be used for countries not covered by other zones. + """ + default: Boolean + + """ + List of warehouses to assign to a shipping zone + """ + addWarehouses: [ID] + + """ + List of channels to assign to the shipping zone. + """ + addChannels: [ID!] +} + +""" +Deletes a shipping zone. +""" +type ShippingZoneDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + shippingErrors: [ShippingError!]! + shippingZone: ShippingZone +} + +""" +Deletes shipping zones. +""" +type ShippingZoneBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + shippingErrors: [ShippingError!]! +} + +""" +Updates a new shipping zone. +""" +type ShippingZoneUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + shippingErrors: [ShippingError!]! + shippingZone: ShippingZone +} + +input ShippingZoneUpdateInput { + """ + Shipping zone's name. Visible only to the staff. + """ + name: String + + """ + Description of the shipping zone. + """ + description: String + + """ + List of countries in this shipping zone. + """ + countries: [String] + + """ + Default shipping zone will be used for countries not covered by other zones. + """ + default: Boolean + + """ + List of warehouses to assign to a shipping zone + """ + addWarehouses: [ID] + + """ + List of channels to assign to the shipping zone. + """ + addChannels: [ID!] + + """ + List of warehouses to unassign from a shipping zone + """ + removeWarehouses: [ID] + + """ + List of channels to unassign from the shipping zone. + """ + removeChannels: [ID!] +} + +""" +Assign attributes to a given product type. +""" +type ProductAttributeAssign { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + The updated product type. + """ + productType: ProductType + productErrors: [ProductError!]! +} + +type ProductError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: ProductErrorCode! + + """ + List of attributes IDs which causes the error. + """ + attributes: [ID!] + + """ + List of attribute values IDs which causes the error. + """ + values: [ID!] +} + +""" +An enumeration. +""" +enum ProductErrorCode { + ALREADY_EXISTS + ATTRIBUTE_ALREADY_ASSIGNED + ATTRIBUTE_CANNOT_BE_ASSIGNED + ATTRIBUTE_VARIANTS_DISABLED + DUPLICATED_INPUT_ITEM + GRAPHQL_ERROR + INVALID + PRODUCT_WITHOUT_CATEGORY + NOT_PRODUCTS_IMAGE + NOT_PRODUCTS_VARIANT + NOT_FOUND + REQUIRED + UNIQUE + VARIANT_NO_DIGITAL_CONTENT + CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT + PRODUCT_NOT_ASSIGNED_TO_CHANNEL + UNSUPPORTED_MEDIA_PROVIDER +} + +input ProductAttributeAssignInput { + """ + The ID of the attribute to assign. + """ + id: ID! + + """ + The attribute type to be assigned as. + """ + type: ProductAttributeType! +} + +enum ProductAttributeType { + PRODUCT + VARIANT +} + +""" +Un-assign attributes from a given product type. +""" +type ProductAttributeUnassign { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + The updated product type. + """ + productType: ProductType + productErrors: [ProductError!]! +} + +""" +Creates a new category. +""" +type CategoryCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + productErrors: [ProductError!]! + category: Category +} + +input CategoryInput { + """ + Category description (JSON). + """ + description: JSONString + + """ + Category name. + """ + name: String + + """ + Category slug. + """ + slug: String + + """ + Search engine optimization fields. + """ + seo: SeoInput + + """ + Background image file. + """ + backgroundImage: Upload + + """ + Alt text for a product media. + """ + backgroundImageAlt: String +} + +input SeoInput { + """ + SEO title. + """ + title: String + + """ + SEO description. + """ + description: String +} + +""" +Variables of this type must be set to null in mutations. They will be replaced with a filename from a following multipart part containing a binary file. See: https://github.com/jaydenseric/graphql-multipart-request-spec. +""" +scalar Upload + +""" +Deletes a category. +""" +type CategoryDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + productErrors: [ProductError!]! + category: Category +} + +""" +Deletes categories. +""" +type CategoryBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + productErrors: [ProductError!]! +} + +""" +Updates a category. +""" +type CategoryUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + productErrors: [ProductError!]! + category: Category +} + +""" +Creates/Updates translations for Category. +""" +type CategoryTranslate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + translationErrors: [TranslationError!]! + category: Category +} + +input TranslationInput { + seoTitle: String + seoDescription: String + name: String + description: JSONString +} + +""" +Adds products to a collection. +""" +type CollectionAddProducts { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Collection to which products will be added. + """ + collection: Collection + collectionErrors: [CollectionError!]! +} + +type CollectionError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + List of products IDs which causes the error. + """ + products: [ID!] + + """ + The error code. + """ + code: CollectionErrorCode! +} + +""" +An enumeration. +""" +enum CollectionErrorCode { + DUPLICATED_INPUT_ITEM + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE + CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT +} + +""" +Creates a new collection. +""" +type CollectionCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + collectionErrors: [CollectionError!]! + collection: Collection +} + +input CollectionCreateInput { + """ + Informs whether a collection is published. + """ + isPublished: Boolean + + """ + Name of the collection. + """ + name: String + + """ + Slug of the collection. + """ + slug: String + + """ + Description of the collection (JSON). + """ + description: JSONString + + """ + Background image file. + """ + backgroundImage: Upload + + """ + Alt text for an image. + """ + backgroundImageAlt: String + + """ + Search engine optimization fields. + """ + seo: SeoInput + + """ + Publication date. ISO 8601 standard. + """ + publicationDate: Date + + """ + List of products to be added to the collection. + """ + products: [ID] +} + +""" +Deletes a collection. +""" +type CollectionDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + collectionErrors: [CollectionError!]! + collection: Collection +} + +""" +Reorder the products of a collection. +""" +type CollectionReorderProducts { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Collection from which products are reordered. + """ + collection: Collection + collectionErrors: [CollectionError!]! +} + +input MoveProductInput { + """ + The ID of the product to move. + """ + productId: ID! + + """ + The relative sorting position of the product (from -inf to +inf) starting from the first given product's actual position.1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged. + """ + sortOrder: Int +} + +""" +Deletes collections. +""" +type CollectionBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + collectionErrors: [CollectionError!]! +} + +""" +Remove products from a collection. +""" +type CollectionRemoveProducts { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Collection from which products will be removed. + """ + collection: Collection + collectionErrors: [CollectionError!]! +} + +""" +Updates a collection. +""" +type CollectionUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + collectionErrors: [CollectionError!]! + collection: Collection +} + +input CollectionInput { + """ + Informs whether a collection is published. + """ + isPublished: Boolean + + """ + Name of the collection. + """ + name: String + + """ + Slug of the collection. + """ + slug: String + + """ + Description of the collection (JSON). + """ + description: JSONString + + """ + Background image file. + """ + backgroundImage: Upload + + """ + Alt text for an image. + """ + backgroundImageAlt: String + + """ + Search engine optimization fields. + """ + seo: SeoInput + + """ + Publication date. ISO 8601 standard. + """ + publicationDate: Date +} + +""" +Creates/Updates translations for collection. +""" +type CollectionTranslate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + translationErrors: [TranslationError!]! + collection: Collection +} + +""" +Manage collection's availability in channels. +""" +type CollectionChannelListingUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated collection instance. + """ + collection: Collection + collectionChannelListingErrors: [CollectionChannelListingError!]! +} + +type CollectionChannelListingError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: ProductErrorCode! + + """ + List of attributes IDs which causes the error. + """ + attributes: [ID!] + + """ + List of attribute values IDs which causes the error. + """ + values: [ID!] + + """ + List of channels IDs which causes the error. + """ + channels: [ID!] +} + +input CollectionChannelListingUpdateInput { + """ + List of channels to which the collection should be assigned. + """ + addChannels: [PublishableChannelListingInput!] + + """ + List of channels from which the collection should be unassigned. + """ + removeChannels: [ID!] +} + +input PublishableChannelListingInput { + """ + ID of a channel. + """ + channelId: ID! + + """ + Determines if object is visible to customers. + """ + isPublished: Boolean + + """ + Publication date. ISO 8601 standard. + """ + publicationDate: Date +} + +""" +Creates a new product. +""" +type ProductCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + productErrors: [ProductError!]! + product: Product +} + +input ProductCreateInput { + """ + List of attributes. + """ + attributes: [AttributeValueInput!] + + """ + ID of the product's category. + """ + category: ID + + """ + Determine if taxes are being charged for the product. + """ + chargeTaxes: Boolean + + """ + List of IDs of collections that the product belongs to. + """ + collections: [ID!] + + """ + Product description (JSON). + """ + description: JSONString + + """ + Product name. + """ + name: String + + """ + Product slug. + """ + slug: String + + """ + Tax rate for enabled tax gateway. + """ + taxCode: String + + """ + Search engine optimization fields. + """ + seo: SeoInput + + """ + Weight of the Product. + """ + weight: WeightScalar + + """ + Defines the product rating value. + """ + rating: Float + + """ + ID of the type that product belongs to. + """ + productType: ID! +} + +input AttributeValueInput { + """ + ID of the selected attribute. + """ + id: ID + + """ + The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created. + """ + values: [String] + + """ + URL of the file attribute. Every time, a new value is created. + """ + file: String + + """ + File content type. + """ + contentType: String + + """ + List of entity IDs that will be used as references. + """ + references: [ID!] + + """ + Text content in JSON format. + """ + richText: JSONString +} + +""" +Deletes a product. +""" +type ProductDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + productErrors: [ProductError!]! + product: Product +} + +""" +Deletes products. +""" +type ProductBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + productErrors: [ProductError!]! +} + +""" +Updates an existing product. +""" +type ProductUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + productErrors: [ProductError!]! + product: Product +} + +input ProductInput { + """ + List of attributes. + """ + attributes: [AttributeValueInput!] + + """ + ID of the product's category. + """ + category: ID + + """ + Determine if taxes are being charged for the product. + """ + chargeTaxes: Boolean + + """ + List of IDs of collections that the product belongs to. + """ + collections: [ID!] + + """ + Product description (JSON). + """ + description: JSONString + + """ + Product name. + """ + name: String + + """ + Product slug. + """ + slug: String + + """ + Tax rate for enabled tax gateway. + """ + taxCode: String + + """ + Search engine optimization fields. + """ + seo: SeoInput + + """ + Weight of the Product. + """ + weight: WeightScalar + + """ + Defines the product rating value. + """ + rating: Float +} + +""" +Creates/Updates translations for Product. +""" +type ProductTranslate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + translationErrors: [TranslationError!]! + product: Product +} + +""" +Manage product's availability in channels. +""" +type ProductChannelListingUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated product instance. + """ + product: Product + productChannelListingErrors: [ProductChannelListingError!]! +} + +type ProductChannelListingError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: ProductErrorCode! + + """ + List of attributes IDs which causes the error. + """ + attributes: [ID!] + + """ + List of attribute values IDs which causes the error. + """ + values: [ID!] + + """ + List of channels IDs which causes the error. + """ + channels: [ID!] + + """ + List of variants IDs which causes the error. + """ + variants: [ID!] +} + +input ProductChannelListingUpdateInput { + """ + List of channels to which the product should be assigned or updated. + """ + updateChannels: [ProductChannelListingAddInput!] + + """ + List of channels from which the product should be unassigned. + """ + removeChannels: [ID!] +} + +input ProductChannelListingAddInput { + """ + ID of a channel. + """ + channelId: ID! + + """ + Determines if object is visible to customers. + """ + isPublished: Boolean + + """ + Publication date. ISO 8601 standard. + """ + publicationDate: Date + + """ + Determines if product is visible in product listings (doesn't apply to product collections). + """ + visibleInListings: Boolean + + """ + Determine if product should be available for purchase. + """ + isAvailableForPurchase: Boolean + + """ + A start date from which a product will be available for purchase. When not set and isAvailable is set to True, the current day is assumed. + """ + availableForPurchaseDate: Date + + """ + List of variants to which the channel should be assigned. + """ + addVariants: [ID!] + + """ + List of variants from which the channel should be unassigned. + """ + removeVariants: [ID!] +} + +""" +Create a media object (image or video URL) associated with product. For image, this mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec +""" +type ProductMediaCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + product: Product + media: ProductMedia + productErrors: [ProductError!]! +} + +input ProductMediaCreateInput { + """ + Alt text for a product media. + """ + alt: String + + """ + Represents an image file in a multipart request. + """ + image: Upload + + """ + ID of an product. + """ + product: ID! + + """ + Represents an URL to an external media. + """ + mediaUrl: String +} + +""" +Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook. +""" +type ProductVariantReorder { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + product: Product + productErrors: [ProductError!]! +} + +input ReorderInput { + """ + The ID of the item to move. + """ + id: ID! + + """ + The new relative sorting position of the item (from -inf to +inf). 1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged. + """ + sortOrder: Int +} + +""" +Deletes a product media. +""" +type ProductMediaDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + product: Product + media: ProductMedia + productErrors: [ProductError!]! +} + +""" +Deletes product media. +""" +type ProductMediaBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + productErrors: [ProductError!]! +} + +""" +Changes ordering of the product media. +""" +type ProductMediaReorder { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + product: Product + media: [ProductMedia!] + productErrors: [ProductError!]! +} + +""" +Updates a product media. +""" +type ProductMediaUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + product: Product + media: ProductMedia + productErrors: [ProductError!]! +} + +input ProductMediaUpdateInput { + """ + Alt text for a product media. + """ + alt: String +} + +""" +Creates a new product type. +""" +type ProductTypeCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + productErrors: [ProductError!]! + productType: ProductType +} + +input ProductTypeInput { + """ + Name of the product type. + """ + name: String + + """ + Product type slug. + """ + slug: String + + """ + Determines if product of this type has multiple variants. This option mainly simplifies product management in the dashboard. There is always at least one variant created under the hood. + """ + hasVariants: Boolean + + """ + List of attributes shared among all product variants. + """ + productAttributes: [ID] + + """ + List of attributes used to distinguish between different variants of a product. + """ + variantAttributes: [ID] + + """ + Determines if shipping is required for products of this variant. + """ + isShippingRequired: Boolean + + """ + Determines if products are digital. + """ + isDigital: Boolean + + """ + Weight of the ProductType items. + """ + weight: WeightScalar + + """ + Tax rate for enabled tax gateway. + """ + taxCode: String +} + +""" +Deletes a product type. +""" +type ProductTypeDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + productErrors: [ProductError!]! + productType: ProductType +} + +""" +Deletes product types. +""" +type ProductTypeBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + productErrors: [ProductError!]! +} + +""" +Updates an existing product type. +""" +type ProductTypeUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + productErrors: [ProductError!]! + productType: ProductType +} + +""" +Reorder the attributes of a product type. +""" +type ProductTypeReorderAttributes { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Product type from which attributes are reordered. + """ + productType: ProductType + productErrors: [ProductError!]! +} + +""" +Reorder product attribute values. +""" +type ProductReorderAttributeValues { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Product from which attribute values are reordered. + """ + product: Product + productErrors: [ProductError!]! +} + +""" +Create new digital content. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec +""" +type DigitalContentCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + variant: ProductVariant + content: DigitalContent + productErrors: [ProductError!]! +} + +input DigitalContentUploadInput { + """ + Use default digital content settings for this product. + """ + useDefaultSettings: Boolean! + + """ + Determines how many times a download link can be accessed by a customer. + """ + maxDownloads: Int + + """ + Determines for how many days a download link is active since it was generated. + """ + urlValidDays: Int + + """ + Overwrite default automatic_fulfillment setting for variant. + """ + automaticFulfillment: Boolean + + """ + Represents an file in a multipart request. + """ + contentFile: Upload! +} + +""" +Remove digital content assigned to given variant. +""" +type DigitalContentDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + variant: ProductVariant + productErrors: [ProductError!]! +} + +""" +Update digital content. +""" +type DigitalContentUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + variant: ProductVariant + content: DigitalContent + productErrors: [ProductError!]! +} + +input DigitalContentInput { + """ + Use default digital content settings for this product. + """ + useDefaultSettings: Boolean! + + """ + Determines how many times a download link can be accessed by a customer. + """ + maxDownloads: Int + + """ + Determines for how many days a download link is active since it was generated. + """ + urlValidDays: Int + + """ + Overwrite default automatic_fulfillment setting for variant. + """ + automaticFulfillment: Boolean +} + +""" +Generate new URL to digital content. +""" +type DigitalContentUrlCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + productErrors: [ProductError!]! + digitalContentUrl: DigitalContentUrl +} + +input DigitalContentUrlCreateInput { + """ + Digital content ID which URL will belong to. + """ + content: ID! +} + +""" +Creates a new variant for a product. +""" +type ProductVariantCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + productErrors: [ProductError!]! + productVariant: ProductVariant +} + +input ProductVariantCreateInput { + """ + List of attributes specific to this variant. + """ + attributes: [AttributeValueInput]! + + """ + Stock keeping unit. + """ + sku: String + + """ + Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item. + """ + trackInventory: Boolean + + """ + Weight of the Product Variant. + """ + weight: WeightScalar + + """ + Product ID of which type is the variant. + """ + product: ID! + + """ + Stocks of a product available for sale. + """ + stocks: [StockInput!] +} + +input StockInput { + """ + Warehouse in which stock is located. + """ + warehouse: ID! + + """ + Quantity of items available for sell. + """ + quantity: Int! +} + +""" +Deletes a product variant. +""" +type ProductVariantDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + productErrors: [ProductError!]! + productVariant: ProductVariant +} + +""" +Creates product variants for a given product. +""" +type ProductVariantBulkCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were created. + """ + count: Int! + + """ + List of the created variants. + """ + productVariants: [ProductVariant!]! + bulkProductErrors: [BulkProductError!]! +} + +type BulkProductError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: ProductErrorCode! + + """ + List of attributes IDs which causes the error. + """ + attributes: [ID!] + + """ + List of attribute values IDs which causes the error. + """ + values: [ID!] + + """ + Index of an input list item that caused the error. + """ + index: Int + + """ + List of warehouse IDs which causes the error. + """ + warehouses: [ID!] + + """ + List of channel IDs which causes the error. + """ + channels: [ID!] +} + +input ProductVariantBulkCreateInput { + """ + List of attributes specific to this variant. + """ + attributes: [BulkAttributeValueInput]! + + """ + Stock keeping unit. + """ + sku: String! + + """ + Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item. + """ + trackInventory: Boolean + + """ + Weight of the Product Variant. + """ + weight: WeightScalar + + """ + Stocks of a product available for sale. + """ + stocks: [StockInput!] + + """ + List of prices assigned to channels. + """ + channelListings: [ProductVariantChannelListingAddInput!] +} + +input BulkAttributeValueInput { + """ + ID of the selected attribute. + """ + id: ID + + """ + The value or slug of an attribute to resolve. If the passed value is non-existent, it will be created. + """ + values: [String]! +} + +input ProductVariantChannelListingAddInput { + """ + ID of a channel. + """ + channelId: ID! + + """ + Price of the particular variant in channel. + """ + price: PositiveDecimal! + + """ + Cost price of the variant in channel. + """ + costPrice: PositiveDecimal +} + +""" +Deletes product variants. +""" +type ProductVariantBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + productErrors: [ProductError!]! +} + +""" +Creates stocks for product variant. +""" +type ProductVariantStocksCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Updated product variant. + """ + productVariant: ProductVariant + bulkStockErrors: [BulkStockError!]! +} + +type BulkStockError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: ProductErrorCode! + + """ + List of attributes IDs which causes the error. + """ + attributes: [ID!] + + """ + List of attribute values IDs which causes the error. + """ + values: [ID!] + + """ + Index of an input list item that caused the error. + """ + index: Int +} + +""" +Delete stocks from product variant. +""" +type ProductVariantStocksDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Updated product variant. + """ + productVariant: ProductVariant + stockErrors: [StockError!]! +} + +type StockError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: StockErrorCode! +} + +""" +An enumeration. +""" +enum StockErrorCode { + ALREADY_EXISTS + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE +} + +""" +Update stocks for product variant. +""" +type ProductVariantStocksUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Updated product variant. + """ + productVariant: ProductVariant + bulkStockErrors: [BulkStockError!]! +} + +""" +Updates an existing variant for product. +""" +type ProductVariantUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + productErrors: [ProductError!]! + productVariant: ProductVariant +} + +input ProductVariantInput { + """ + List of attributes specific to this variant. + """ + attributes: [AttributeValueInput] + + """ + Stock keeping unit. + """ + sku: String + + """ + Determines if the inventory of this variant should be tracked. If false, the quantity won't change when customers buy this item. + """ + trackInventory: Boolean + + """ + Weight of the Product Variant. + """ + weight: WeightScalar +} + +""" +Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook. +""" +type ProductVariantSetDefault { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + product: Product + productErrors: [ProductError!]! +} + +""" +Creates/Updates translations for Product Variant. +""" +type ProductVariantTranslate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + translationErrors: [TranslationError!]! + productVariant: ProductVariant +} + +""" +Manage product variant prices in channels. +""" +type ProductVariantChannelListingUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated product variant instance. + """ + variant: ProductVariant + productChannelListingErrors: [ProductChannelListingError!]! +} + +""" +Reorder product variant attribute values. +""" +type ProductVariantReorderAttributeValues { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Product variant from which attribute values are reordered. + """ + productVariant: ProductVariant + productErrors: [ProductError!]! +} + +""" +Assign an media to a product variant. +""" +type VariantMediaAssign { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + productVariant: ProductVariant + media: ProductMedia + productErrors: [ProductError!]! +} + +""" +Unassign an media from a product variant. +""" +type VariantMediaUnassign { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + productVariant: ProductVariant + media: ProductMedia + productErrors: [ProductError!]! +} + +""" +Captures the authorized payment amount. +""" +type PaymentCapture { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Updated payment. + """ + payment: Payment + paymentErrors: [PaymentError!]! +} + +type PaymentError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: PaymentErrorCode! +} + +""" +An enumeration. +""" +enum PaymentErrorCode { + BILLING_ADDRESS_NOT_SET + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE + PARTIAL_PAYMENT_NOT_ALLOWED + SHIPPING_ADDRESS_NOT_SET + INVALID_SHIPPING_METHOD + SHIPPING_METHOD_NOT_SET + PAYMENT_ERROR + NOT_SUPPORTED_GATEWAY +} + +""" +Refunds the captured payment amount. +""" +type PaymentRefund { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Updated payment. + """ + payment: Payment + paymentErrors: [PaymentError!]! +} + +""" +Voids the authorized payment. +""" +type PaymentVoid { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Updated payment. + """ + payment: Payment + paymentErrors: [PaymentError!]! +} + +""" +Initializes payment process when it is required by gateway. +""" +type PaymentInitialize { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + initializedPayment: PaymentInitialized + paymentErrors: [PaymentError!]! +} + +""" +Server-side data generated by a payment gateway. Optional step when the payment provider requires an additional action to initialize payment session. +""" +type PaymentInitialized { + """ + ID of a payment gateway. + """ + gateway: String! + + """ + Payment gateway name. + """ + name: String! + + """ + Initialized data by gateway. + """ + data: JSONString +} + +""" +Creates a new page. +""" +type PageCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + pageErrors: [PageError!]! + page: Page +} + +type PageError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: PageErrorCode! + + """ + List of attributes IDs which causes the error. + """ + attributes: [ID!] + + """ + List of attribute values IDs which causes the error. + """ + values: [ID!] +} + +""" +An enumeration. +""" +enum PageErrorCode { + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE + DUPLICATED_INPUT_ITEM + ATTRIBUTE_ALREADY_ASSIGNED +} + +input PageCreateInput { + """ + Page internal name. + """ + slug: String + + """ + Page title. + """ + title: String + + """ + Page content in JSON format. + """ + content: JSONString + + """ + List of attributes. + """ + attributes: [AttributeValueInput!] + + """ + Determines if page is visible in the storefront. + """ + isPublished: Boolean + + """ + Publication date. ISO 8601 standard. + """ + publicationDate: String + + """ + Search engine optimization fields. + """ + seo: SeoInput + + """ + ID of the page type that page belongs to. + """ + pageType: ID! +} + +""" +Deletes a page. +""" +type PageDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + pageErrors: [PageError!]! + page: Page +} + +""" +Deletes pages. +""" +type PageBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + pageErrors: [PageError!]! +} + +""" +Publish pages. +""" +type PageBulkPublish { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + pageErrors: [PageError!]! +} + +""" +Updates an existing page. +""" +type PageUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + pageErrors: [PageError!]! + page: Page +} + +input PageInput { + """ + Page internal name. + """ + slug: String + + """ + Page title. + """ + title: String + + """ + Page content in JSON format. + """ + content: JSONString + + """ + List of attributes. + """ + attributes: [AttributeValueInput!] + + """ + Determines if page is visible in the storefront. + """ + isPublished: Boolean + + """ + Publication date. ISO 8601 standard. + """ + publicationDate: String + + """ + Search engine optimization fields. + """ + seo: SeoInput +} + +""" +Creates/Updates translations for Page. +""" +type PageTranslate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + translationErrors: [TranslationError!]! + page: PageTranslatableContent +} + +input PageTranslationInput { + seoTitle: String + seoDescription: String + title: String + content: JSONString +} + +""" +Create a new page type. +""" +type PageTypeCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + pageErrors: [PageError!]! + pageType: PageType +} + +input PageTypeCreateInput { + """ + Name of the page type. + """ + name: String + + """ + Page type slug. + """ + slug: String + + """ + List of attribute IDs to be assigned to the page type. + """ + addAttributes: [ID!] +} + +""" +Update page type. +""" +type PageTypeUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + pageErrors: [PageError!]! + pageType: PageType +} + +input PageTypeUpdateInput { + """ + Name of the page type. + """ + name: String + + """ + Page type slug. + """ + slug: String + + """ + List of attribute IDs to be assigned to the page type. + """ + addAttributes: [ID!] + + """ + List of attribute IDs to be assigned to the page type. + """ + removeAttributes: [ID!] +} + +""" +Delete a page type. +""" +type PageTypeDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + pageErrors: [PageError!]! + pageType: PageType +} + +""" +Delete page types. +""" +type PageTypeBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + pageErrors: [PageError!]! +} + +""" +Assign attributes to a given page type. +""" +type PageAttributeAssign { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + The updated page type. + """ + pageType: PageType + pageErrors: [PageError!]! +} + +""" +Unassign attributes from a given page type. +""" +type PageAttributeUnassign { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + The updated page type. + """ + pageType: PageType + pageErrors: [PageError!]! +} + +""" +Reorder the attributes of a page type. +""" +type PageTypeReorderAttributes { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Page type from which attributes are reordered. + """ + pageType: PageType + pageErrors: [PageError!]! +} + +""" +Reorder page attribute values. +""" +type PageReorderAttributeValues { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Page from which attribute values are reordered. + """ + page: Page + pageErrors: [PageError!]! +} + +""" +Completes creating an order. +""" +type DraftOrderComplete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Completed order. + """ + order: Order + orderErrors: [OrderError!]! +} + +type OrderError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: OrderErrorCode! + + """ + Warehouse ID which causes the error. + """ + warehouse: ID + + """ + Order line ID which causes the error. + """ + orderLine: ID + + """ + List of product variants that are associated with the error + """ + variants: [ID!] +} + +""" +An enumeration. +""" +enum OrderErrorCode { + BILLING_ADDRESS_NOT_SET + CANNOT_CANCEL_FULFILLMENT + CANNOT_CANCEL_ORDER + CANNOT_DELETE + CANNOT_DISCOUNT + CANNOT_REFUND + CAPTURE_INACTIVE_PAYMENT + NOT_EDITABLE + FULFILL_ORDER_LINE + GRAPHQL_ERROR + INVALID + PRODUCT_NOT_PUBLISHED + PRODUCT_UNAVAILABLE_FOR_PURCHASE + NOT_FOUND + ORDER_NO_SHIPPING_ADDRESS + PAYMENT_ERROR + PAYMENT_MISSING + REQUIRED + SHIPPING_METHOD_NOT_APPLICABLE + SHIPPING_METHOD_REQUIRED + TAX_ERROR + UNIQUE + VOID_INACTIVE_PAYMENT + ZERO_QUANTITY + INVALID_QUANTITY + INSUFFICIENT_STOCK + DUPLICATED_INPUT_ITEM + NOT_AVAILABLE_IN_CHANNEL + CHANNEL_INACTIVE +} + +""" +Creates a new draft order. +""" +type DraftOrderCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + orderErrors: [OrderError!]! + order: Order +} + +input DraftOrderCreateInput { + """ + Billing address of the customer. + """ + billingAddress: AddressInput + user: ID + + """ + Email address of the customer. + """ + userEmail: String + + """ + Discount amount for the order. + """ + discount: PositiveDecimal + + """ + Shipping address of the customer. + """ + shippingAddress: AddressInput + + """ + ID of a selected shipping method. + """ + shippingMethod: ID + + """ + ID of the voucher associated with the order. + """ + voucher: ID + + """ + A note from a customer. Visible by customers in the order summary. + """ + customerNote: String + + """ + ID of the channel associated with the order. + """ + channel: ID + + """ + URL of a view where users should be redirected to see the order details. URL in RFC 1808 format. + """ + redirectUrl: String + + """ + Variant line input consisting of variant ID and quantity of products. + """ + lines: [OrderLineCreateInput] +} + +input OrderLineCreateInput { + """ + Number of variant items ordered. + """ + quantity: Int! + + """ + Product variant ID. + """ + variantId: ID! +} + +""" +Deletes a draft order. +""" +type DraftOrderDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + orderErrors: [OrderError!]! + order: Order +} + +""" +Deletes draft orders. +""" +type DraftOrderBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + orderErrors: [OrderError!]! +} + +""" +Deletes order lines. +""" +type DraftOrderLinesBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + orderErrors: [OrderError!]! +} + +""" +Updates a draft order. +""" +type DraftOrderUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + orderErrors: [OrderError!]! + order: Order +} + +input DraftOrderInput { + """ + Billing address of the customer. + """ + billingAddress: AddressInput + user: ID + + """ + Email address of the customer. + """ + userEmail: String + + """ + Discount amount for the order. + """ + discount: PositiveDecimal + + """ + Shipping address of the customer. + """ + shippingAddress: AddressInput + + """ + ID of a selected shipping method. + """ + shippingMethod: ID + + """ + ID of the voucher associated with the order. + """ + voucher: ID + + """ + A note from a customer. Visible by customers in the order summary. + """ + customerNote: String + + """ + ID of the channel associated with the order. + """ + channel: ID + + """ + URL of a view where users should be redirected to see the order details. URL in RFC 1808 format. + """ + redirectUrl: String +} + +""" +Adds note to the order. +""" +type OrderAddNote { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Order with the note added. + """ + order: Order + + """ + Order note created. + """ + event: OrderEvent + orderErrors: [OrderError!]! +} + +input OrderAddNoteInput { + """ + Note message. + """ + message: String! +} + +""" +Cancel an order. +""" +type OrderCancel { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Canceled order. + """ + order: Order + orderErrors: [OrderError!]! +} + +""" +Capture an order. +""" +type OrderCapture { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Captured order. + """ + order: Order + orderErrors: [OrderError!]! +} + +""" +Confirms an unconfirmed order by changing status to unfulfilled. +""" +type OrderConfirm { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + order: Order + orderErrors: [OrderError!]! +} + +""" +Creates new fulfillments for an order. +""" +type OrderFulfill { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + List of created fulfillments. + """ + fulfillments: [Fulfillment] + + """ + Fulfilled order. + """ + order: Order + orderErrors: [OrderError!]! +} + +input OrderFulfillInput { + """ + List of items informing how to fulfill the order. + """ + lines: [OrderFulfillLineInput!]! + + """ + If true, send an email notification to the customer. + """ + notifyCustomer: Boolean +} + +input OrderFulfillLineInput { + """ + The ID of the order line. + """ + orderLineId: ID + + """ + List of stock items to create. + """ + stocks: [OrderFulfillStockInput!]! +} + +input OrderFulfillStockInput { + """ + The number of line items to be fulfilled from given warehouse. + """ + quantity: Int! + + """ + ID of the warehouse from which the item will be fulfilled. + """ + warehouse: ID! +} + +""" +Cancels existing fulfillment and optionally restocks items. +""" +type FulfillmentCancel { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A canceled fulfillment. + """ + fulfillment: Fulfillment + + """ + Order which fulfillment was cancelled. + """ + order: Order + orderErrors: [OrderError!]! +} + +input FulfillmentCancelInput { + """ + ID of warehouse where items will be restock. + """ + warehouseId: ID! +} + +""" +Updates a fulfillment for an order. +""" +type FulfillmentUpdateTracking { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A fulfillment with updated tracking. + """ + fulfillment: Fulfillment + + """ + Order for which fulfillment was updated. + """ + order: Order + orderErrors: [OrderError!]! +} + +input FulfillmentUpdateTrackingInput { + """ + Fulfillment tracking number. + """ + trackingNumber: String + + """ + If true, send an email notification to the customer. + """ + notifyCustomer: Boolean +} + +""" +Refund products. +""" +type FulfillmentRefundProducts { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A refunded fulfillment. + """ + fulfillment: Fulfillment + + """ + Order which fulfillment was refunded. + """ + order: Order + orderErrors: [OrderError!]! +} + +input OrderRefundProductsInput { + """ + List of unfulfilled lines to refund. + """ + orderLines: [OrderRefundLineInput!] + + """ + List of fulfilled lines to refund. + """ + fulfillmentLines: [OrderRefundFulfillmentLineInput!] + + """ + The total amount of refund when the value is provided manually. + """ + amountToRefund: PositiveDecimal + + """ + If true, Saleor will refund shipping costs. If amountToRefund is providedincludeShippingCosts will be ignored. + """ + includeShippingCosts: Boolean +} + +input OrderRefundLineInput { + """ + The ID of the order line to refund. + """ + orderLineId: ID! + + """ + The number of items to be refunded. + """ + quantity: Int! +} + +input OrderRefundFulfillmentLineInput { + """ + The ID of the fulfillment line to refund. + """ + fulfillmentLineId: ID! + + """ + The number of items to be refunded. + """ + quantity: Int! +} + +""" +Return products. +""" +type FulfillmentReturnProducts { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A return fulfillment. + """ + returnFulfillment: Fulfillment + + """ + A replace fulfillment. + """ + replaceFulfillment: Fulfillment + + """ + Order which fulfillment was returned. + """ + order: Order + + """ + A draft order which was created for products with replace flag. + """ + replaceOrder: Order + orderErrors: [OrderError!]! +} + +input OrderReturnProductsInput { + """ + List of unfulfilled lines to return. + """ + orderLines: [OrderReturnLineInput!] + + """ + List of fulfilled lines to return. + """ + fulfillmentLines: [OrderReturnFulfillmentLineInput!] + + """ + The total amount of refund when the value is provided manually. + """ + amountToRefund: PositiveDecimal + + """ + If true, Saleor will refund shipping costs. If amountToRefund is providedincludeShippingCosts will be ignored. + """ + includeShippingCosts: Boolean + + """ + If true, Saleor will call refund action for all lines. + """ + refund: Boolean +} + +input OrderReturnLineInput { + """ + The ID of the order line to return. + """ + orderLineId: ID! + + """ + The number of items to be returned. + """ + quantity: Int! + + """ + Determines, if the line should be added to replace order. + """ + replace: Boolean +} + +input OrderReturnFulfillmentLineInput { + """ + The ID of the fulfillment line to return. + """ + fulfillmentLineId: ID! + + """ + The number of items to be returned. + """ + quantity: Int! + + """ + Determines, if the line should be added to replace order. + """ + replace: Boolean +} + +""" +Create order lines for an order. +""" +type OrderLinesCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Related order. + """ + order: Order + + """ + List of added order lines. + """ + orderLines: [OrderLine!] + orderErrors: [OrderError!]! +} + +""" +Deletes an order line from an order. +""" +type OrderLineDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A related order. + """ + order: Order + + """ + An order line that was deleted. + """ + orderLine: OrderLine + orderErrors: [OrderError!]! +} + +""" +Updates an order line of an order. +""" +type OrderLineUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Related order. + """ + order: Order + orderErrors: [OrderError!]! + orderLine: OrderLine +} + +input OrderLineInput { + """ + Number of variant items ordered. + """ + quantity: Int! +} + +""" +Adds discount to the order. +""" +type OrderDiscountAdd { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Order which has been discounted. + """ + order: Order + orderErrors: [OrderError!]! +} + +input OrderDiscountCommonInput { + """ + Type of the discount: fixed or percent + """ + valueType: DiscountValueTypeEnum! + + """ + Value of the discount. Can store fixed value or percent value + """ + value: PositiveDecimal! + + """ + Explanation for the applied discount. + """ + reason: String +} + +""" +Update discount for the order. +""" +type OrderDiscountUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Order which has been discounted. + """ + order: Order + orderErrors: [OrderError!]! +} + +""" +Remove discount from the order. +""" +type OrderDiscountDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Order which has removed discount. + """ + order: Order + orderErrors: [OrderError!]! +} + +""" +Update discount for the order line. +""" +type OrderLineDiscountUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Order line which has been discounted. + """ + orderLine: OrderLine + + """ + Order which is related to the discounted line. + """ + order: Order + orderErrors: [OrderError!]! +} + +""" +Remove discount applied to the order line. +""" +type OrderLineDiscountRemove { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Order line which has removed discount. + """ + orderLine: OrderLine + + """ + Order which is related to line which has removed discount. + """ + order: Order + orderErrors: [OrderError!]! +} + +""" +Mark order as manually paid. +""" +type OrderMarkAsPaid { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Order marked as paid. + """ + order: Order + orderErrors: [OrderError!]! +} + +""" +Refund an order. +""" +type OrderRefund { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A refunded order. + """ + order: Order + orderErrors: [OrderError!]! +} + +""" +Updates an order. +""" +type OrderUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + orderErrors: [OrderError!]! + order: Order +} + +input OrderUpdateInput { + """ + Billing address of the customer. + """ + billingAddress: AddressInput + + """ + Email address of the customer. + """ + userEmail: String + + """ + Shipping address of the customer. + """ + shippingAddress: AddressInput +} + +""" +Updates a shipping method of the order. +""" +type OrderUpdateShipping { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Order with updated shipping method. + """ + order: Order + orderErrors: [OrderError!]! +} + +input OrderUpdateShippingInput { + """ + ID of the selected shipping method. + """ + shippingMethod: ID +} + +""" +Void an order. +""" +type OrderVoid { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A voided order. + """ + order: Order + orderErrors: [OrderError!]! +} + +""" +Cancels orders. +""" +type OrderBulkCancel { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + orderErrors: [OrderError!]! +} + +""" +Delete metadata of an object. +""" +type DeleteMetadata { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + metadataErrors: [MetadataError!]! + item: ObjectWithMetadata +} + +type MetadataError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: MetadataErrorCode! +} + +""" +An enumeration. +""" +enum MetadataErrorCode { + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED +} + +""" +Delete object's private metadata. +""" +type DeletePrivateMetadata { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + metadataErrors: [MetadataError!]! + item: ObjectWithMetadata +} + +""" +Updates metadata of an object. +""" +type UpdateMetadata { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + metadataErrors: [MetadataError!]! + item: ObjectWithMetadata +} + +""" +Updates private metadata of an object. +""" +type UpdatePrivateMetadata { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + metadataErrors: [MetadataError!]! + item: ObjectWithMetadata +} + +""" +Assigns storefront's navigation menus. +""" +type AssignNavigation { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Assigned navigation menu. + """ + menu: Menu + menuErrors: [MenuError!]! +} + +type MenuError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: MenuErrorCode! +} + +""" +An enumeration. +""" +enum MenuErrorCode { + CANNOT_ASSIGN_NODE + GRAPHQL_ERROR + INVALID + INVALID_MENU_ITEM + NO_MENU_ITEM_PROVIDED + NOT_FOUND + REQUIRED + TOO_MANY_MENU_ITEMS + UNIQUE +} + +enum NavigationType { + """ + Main storefront navigation. + """ + MAIN + + """ + Secondary storefront navigation. + """ + SECONDARY +} + +""" +Creates a new Menu. +""" +type MenuCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + menuErrors: [MenuError!]! + menu: Menu +} + +input MenuCreateInput { + """ + Name of the menu. + """ + name: String! + + """ + Slug of the menu. Will be generated if not provided. + """ + slug: String + + """ + List of menu items. + """ + items: [MenuItemInput] +} + +input MenuItemInput { + """ + Name of the menu item. + """ + name: String + + """ + URL of the pointed item. + """ + url: String + + """ + Category to which item points. + """ + category: ID + + """ + Collection to which item points. + """ + collection: ID + + """ + Page to which item points. + """ + page: ID +} + +""" +Deletes a menu. +""" +type MenuDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + menuErrors: [MenuError!]! + menu: Menu +} + +""" +Deletes menus. +""" +type MenuBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + menuErrors: [MenuError!]! +} + +""" +Updates a menu. +""" +type MenuUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + menuErrors: [MenuError!]! + menu: Menu +} + +input MenuInput { + """ + Name of the menu. + """ + name: String + + """ + Slug of the menu. + """ + slug: String +} + +""" +Creates a new menu item. +""" +type MenuItemCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + menuErrors: [MenuError!]! + menuItem: MenuItem +} + +input MenuItemCreateInput { + """ + Name of the menu item. + """ + name: String! + + """ + URL of the pointed item. + """ + url: String + + """ + Category to which item points. + """ + category: ID + + """ + Collection to which item points. + """ + collection: ID + + """ + Page to which item points. + """ + page: ID + + """ + Menu to which item belongs. + """ + menu: ID! + + """ + ID of the parent menu. If empty, menu will be top level menu. + """ + parent: ID +} + +""" +Deletes a menu item. +""" +type MenuItemDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + menuErrors: [MenuError!]! + menuItem: MenuItem +} + +""" +Deletes menu items. +""" +type MenuItemBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + menuErrors: [MenuError!]! +} + +""" +Updates a menu item. +""" +type MenuItemUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + menuErrors: [MenuError!]! + menuItem: MenuItem +} + +""" +Creates/Updates translations for Menu Item. +""" +type MenuItemTranslate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + translationErrors: [TranslationError!]! + menuItem: MenuItem +} + +""" +Moves items of menus. +""" +type MenuItemMove { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Assigned menu to move within. + """ + menu: Menu + menuErrors: [MenuError!]! +} + +input MenuItemMoveInput { + """ + The menu item ID to move. + """ + itemId: ID! + + """ + ID of the parent menu. If empty, menu will be top level menu. + """ + parentId: ID + + """ + The new relative sorting position of the item (from -inf to +inf). 1 moves the item one position forward, -1 moves the item one position backward, 0 leaves the item unchanged. + """ + sortOrder: Int +} + +""" +Request an invoice for the order using plugin. +""" +type InvoiceRequest { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Order related to an invoice. + """ + order: Order + invoiceErrors: [InvoiceError!]! + invoice: Invoice +} + +type InvoiceError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: InvoiceErrorCode! +} + +""" +An enumeration. +""" +enum InvoiceErrorCode { + REQUIRED + NOT_READY + URL_NOT_SET + EMAIL_NOT_SET + NUMBER_NOT_SET + NOT_FOUND + INVALID_STATUS +} + +""" +Requests deletion of an invoice. +""" +type InvoiceRequestDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + invoiceErrors: [InvoiceError!]! + invoice: Invoice +} + +""" +Creates a ready to send invoice. +""" +type InvoiceCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + invoiceErrors: [InvoiceError!]! + invoice: Invoice +} + +input InvoiceCreateInput { + """ + Invoice number. + """ + number: String! + + """ + URL of an invoice to download. """ url: String! - - """ - The width of the video. - """ - width: Int! } """ -Units of measurement for weight. +Deletes an invoice. """ -enum WeightUnit { +type InvoiceDelete { """ - 1 kilogram equals 1000 grams. + List of errors that occurred executing the mutation. """ - KILOGRAMS - - """ - Metric system unit of mass. - """ - GRAMS - - """ - 1 pound equals 16 ounces. - """ - POUNDS - - """ - Imperial system unit of mass. - """ - OUNCES + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + invoiceErrors: [InvoiceError!]! + invoice: Invoice +} + +""" +Updates an invoice. +""" +type InvoiceUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + invoiceErrors: [InvoiceError!]! + invoice: Invoice +} + +input UpdateInvoiceInput { + """ + Invoice number + """ + number: String + + """ + URL of an invoice to download. + """ + url: String +} + +""" +Send an invoice notification to the customer. +""" +type InvoiceSendNotification { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + invoiceErrors: [InvoiceError!]! + invoice: Invoice +} + +""" +Activate a gift card. +""" +type GiftCardActivate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A gift card to activate. + """ + giftCard: GiftCard + giftCardErrors: [GiftCardError!]! +} + +type GiftCardError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: GiftCardErrorCode! +} + +""" +An enumeration. +""" +enum GiftCardErrorCode { + ALREADY_EXISTS + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE +} + +""" +Creates a new gift card. +""" +type GiftCardCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + giftCardErrors: [GiftCardError!]! + giftCard: GiftCard +} + +input GiftCardCreateInput { + """ + Start date of the gift card in ISO 8601 format. + """ + startDate: Date + + """ + End date of the gift card in ISO 8601 format. + """ + endDate: Date + + """ + Value of the gift card. + """ + balance: PositiveDecimal + + """ + The customer's email of the gift card buyer. + """ + userEmail: String + + """ + Code to use the gift card. + """ + code: String +} + +""" +Deactivate a gift card. +""" +type GiftCardDeactivate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A gift card to deactivate. + """ + giftCard: GiftCard + giftCardErrors: [GiftCardError!]! +} + +""" +Update a gift card. +""" +type GiftCardUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + giftCardErrors: [GiftCardError!]! + giftCard: GiftCard +} + +input GiftCardUpdateInput { + """ + Start date of the gift card in ISO 8601 format. + """ + startDate: Date + + """ + End date of the gift card in ISO 8601 format. + """ + endDate: Date + + """ + Value of the gift card. + """ + balance: PositiveDecimal + + """ + The customer's email of the gift card buyer. + """ + userEmail: String +} + +""" +Update plugin configuration. +""" +type PluginUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + plugin: Plugin + pluginsErrors: [PluginError!]! +} + +type PluginError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: PluginErrorCode! +} + +""" +An enumeration. +""" +enum PluginErrorCode { + GRAPHQL_ERROR + INVALID + PLUGIN_MISCONFIGURED + NOT_FOUND + REQUIRED + UNIQUE +} + +input PluginUpdateInput { + """ + Indicates whether the plugin should be enabled. + """ + active: Boolean + + """ + Configuration of the plugin. + """ + configuration: [ConfigurationItemInput] +} + +input ConfigurationItemInput { + """ + Name of the field to update. + """ + name: String! + + """ + Value of the given field to update. + """ + value: String +} + +""" +Creates a new sale. +""" +type SaleCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + discountErrors: [DiscountError!]! + sale: Sale +} + +type DiscountError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + List of products IDs which causes the error. + """ + products: [ID!] + + """ + The error code. + """ + code: DiscountErrorCode! + + """ + List of channels IDs which causes the error. + """ + channels: [ID!] +} + +""" +An enumeration. +""" +enum DiscountErrorCode { + ALREADY_EXISTS + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE + CANNOT_MANAGE_PRODUCT_WITHOUT_VARIANT + DUPLICATED_INPUT_ITEM +} + +input SaleInput { + """ + Voucher name. + """ + name: String + + """ + Fixed or percentage. + """ + type: DiscountValueTypeEnum + + """ + Value of the voucher. + """ + value: PositiveDecimal + + """ + Products related to the discount. + """ + products: [ID] + + """ + Categories related to the discount. + """ + categories: [ID] + + """ + Collections related to the discount. + """ + collections: [ID] + + """ + Start date of the voucher in ISO 8601 format. + """ + startDate: DateTime + + """ + End date of the voucher in ISO 8601 format. + """ + endDate: DateTime +} + +""" +Deletes a sale. +""" +type SaleDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + discountErrors: [DiscountError!]! + sale: Sale +} + +""" +Deletes sales. +""" +type SaleBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + discountErrors: [DiscountError!]! +} + +""" +Updates a sale. +""" +type SaleUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + discountErrors: [DiscountError!]! + sale: Sale +} + +""" +Adds products, categories, collections to a voucher. +""" +type SaleAddCatalogues { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Sale of which catalogue IDs will be modified. + """ + sale: Sale + discountErrors: [DiscountError!]! +} + +input CatalogueInput { + """ + Products related to the discount. + """ + products: [ID] + + """ + Categories related to the discount. + """ + categories: [ID] + + """ + Collections related to the discount. + """ + collections: [ID] +} + +""" +Removes products, categories, collections from a sale. +""" +type SaleRemoveCatalogues { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Sale of which catalogue IDs will be modified. + """ + sale: Sale + discountErrors: [DiscountError!]! +} + +""" +Creates/updates translations for a sale. +""" +type SaleTranslate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + translationErrors: [TranslationError!]! + sale: Sale +} + +""" +Manage sale's availability in channels. +""" +type SaleChannelListingUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated sale instance. + """ + sale: Sale + discountErrors: [DiscountError!]! +} + +input SaleChannelListingInput { + """ + List of channels to which the sale should be assigned. + """ + addChannels: [SaleChannelListingAddInput!] + + """ + List of channels from which the sale should be unassigned. + """ + removeChannels: [ID!] +} + +input SaleChannelListingAddInput { + """ + ID of a channel. + """ + channelId: ID! + + """ + The value of the discount. + """ + discountValue: PositiveDecimal! +} + +""" +Creates a new voucher. +""" +type VoucherCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + discountErrors: [DiscountError!]! + voucher: Voucher +} + +input VoucherInput { + """ + Voucher type: PRODUCT, CATEGORY SHIPPING or ENTIRE_ORDER. + """ + type: VoucherTypeEnum + + """ + Voucher name. + """ + name: String + + """ + Code to use the voucher. + """ + code: String + + """ + Start date of the voucher in ISO 8601 format. + """ + startDate: DateTime + + """ + End date of the voucher in ISO 8601 format. + """ + endDate: DateTime + + """ + Choices: fixed or percentage. + """ + discountValueType: DiscountValueTypeEnum + + """ + Products discounted by the voucher. + """ + products: [ID] + + """ + Collections discounted by the voucher. + """ + collections: [ID] + + """ + Categories discounted by the voucher. + """ + categories: [ID] + + """ + Minimal quantity of checkout items required to apply the voucher. + """ + minCheckoutItemsQuantity: Int + + """ + Country codes that can be used with the shipping voucher. + """ + countries: [String] + + """ + Voucher should be applied to the cheapest item or entire order. + """ + applyOncePerOrder: Boolean + + """ + Voucher should be applied once per customer. + """ + applyOncePerCustomer: Boolean + + """ + Limit number of times this voucher can be used in total. + """ + usageLimit: Int +} + +""" +Deletes a voucher. +""" +type VoucherDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + discountErrors: [DiscountError!]! + voucher: Voucher +} + +""" +Deletes vouchers. +""" +type VoucherBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + discountErrors: [DiscountError!]! +} + +""" +Updates a voucher. +""" +type VoucherUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + discountErrors: [DiscountError!]! + voucher: Voucher +} + +""" +Adds products, categories, collections to a voucher. +""" +type VoucherAddCatalogues { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Voucher of which catalogue IDs will be modified. + """ + voucher: Voucher + discountErrors: [DiscountError!]! +} + +""" +Removes products, categories, collections from a voucher. +""" +type VoucherRemoveCatalogues { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Voucher of which catalogue IDs will be modified. + """ + voucher: Voucher + discountErrors: [DiscountError!]! +} + +""" +Creates/Updates translations for Voucher. +""" +type VoucherTranslate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + translationErrors: [TranslationError!]! + voucher: Voucher +} + +""" +Manage voucher's availability in channels. +""" +type VoucherChannelListingUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated voucher instance. + """ + voucher: Voucher + discountErrors: [DiscountError!]! +} + +input VoucherChannelListingInput { + """ + List of channels to which the voucher should be assigned. + """ + addChannels: [VoucherChannelListingAddInput!] + + """ + List of channels from which the voucher should be unassigned. + """ + removeChannels: [ID!] +} + +input VoucherChannelListingAddInput { + """ + ID of a channel. + """ + channelId: ID! + + """ + Value of the voucher. + """ + discountValue: PositiveDecimal + + """ + Min purchase amount required to apply the voucher. + """ + minAmountSpent: PositiveDecimal +} + +""" +Export products to csv file. +""" +type ExportProducts { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + The newly created export file job which is responsible for export data. + """ + exportFile: ExportFile + exportErrors: [ExportError!]! +} + +type ExportError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: ExportErrorCode! +} + +""" +An enumeration. +""" +enum ExportErrorCode { + INVALID + NOT_FOUND + REQUIRED +} + +input ExportProductsInput { + """ + Determine which products should be exported. + """ + scope: ExportScope! + + """ + Filtering options for products. + """ + filter: ProductFilterInput + + """ + List of products IDS to export. + """ + ids: [ID!] + + """ + Input with info about fields which should be exported. + """ + exportInfo: ExportInfoInput + + """ + Type of exported file. + """ + fileType: FileTypesEnum! +} + +enum ExportScope { + """ + Export all products. + """ + ALL + + """ + Export products with given ids. + """ + IDS + + """ + Export the filtered products. + """ + FILTER +} + +input ExportInfoInput { + """ + List of attribute ids witch should be exported. + """ + attributes: [ID!] + + """ + List of warehouse ids witch should be exported. + """ + warehouses: [ID!] + + """ + List of channels ids which should be exported. + """ + channels: [ID!] + + """ + List of product fields witch should be exported. + """ + fields: [ProductFieldEnum!] +} + +enum ProductFieldEnum { + NAME + DESCRIPTION + PRODUCT_TYPE + CATEGORY + VISIBLE + PRODUCT_WEIGHT + COLLECTIONS + CHARGE_TAXES + PRODUCT_MEDIA + VARIANT_SKU + VARIANT_WEIGHT + VARIANT_MEDIA +} + +""" +An enumeration. +""" +enum FileTypesEnum { + CSV + XLSX +} + +""" +Upload a file. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec +""" +type FileUpload { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + uploadedFile: File + uploadErrors: [UploadError!]! +} + +type UploadError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: UploadErrorCode! +} + +""" +An enumeration. +""" +enum UploadErrorCode { + GRAPHQL_ERROR +} + +""" +Adds a gift card or a voucher to a checkout. +""" +type CheckoutAddPromoCode { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + The checkout with the added gift card or voucher. + """ + checkout: Checkout + checkoutErrors: [CheckoutError!]! +} + +type CheckoutError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: CheckoutErrorCode! + + """ + List of varint IDs which causes the error. + """ + variants: [ID!] +} + +""" +An enumeration. +""" +enum CheckoutErrorCode { + BILLING_ADDRESS_NOT_SET + CHECKOUT_NOT_FULLY_PAID + GRAPHQL_ERROR + PRODUCT_NOT_PUBLISHED + PRODUCT_UNAVAILABLE_FOR_PURCHASE + INSUFFICIENT_STOCK + INVALID + INVALID_SHIPPING_METHOD + NOT_FOUND + PAYMENT_ERROR + QUANTITY_GREATER_THAN_LIMIT + REQUIRED + SHIPPING_ADDRESS_NOT_SET + SHIPPING_METHOD_NOT_APPLICABLE + SHIPPING_METHOD_NOT_SET + SHIPPING_NOT_REQUIRED + TAX_ERROR + UNIQUE + VOUCHER_NOT_APPLICABLE + ZERO_QUANTITY + MISSING_CHANNEL_SLUG + CHANNEL_INACTIVE + UNAVAILABLE_VARIANT_IN_CHANNEL +} + +""" +Update billing address in the existing checkout. +""" +type CheckoutBillingAddressUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated checkout. + """ + checkout: Checkout + checkoutErrors: [CheckoutError!]! +} + +""" +Completes the checkout. As a result a new order is created and a payment charge is made. This action requires a successful payment before it can be performed. In case additional confirmation step as 3D secure is required confirmationNeeded flag will be set to True and no order created until payment is confirmed with second call of this mutation. +""" +type CheckoutComplete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Placed order. + """ + order: Order + + """ + Set to true if payment needs to be confirmed before checkout is complete. + """ + confirmationNeeded: Boolean! + + """ + Confirmation data used to process additional authorization steps. + """ + confirmationData: JSONString + checkoutErrors: [CheckoutError!]! +} + +""" +Create a new checkout. +""" +type CheckoutCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Whether the checkout was created or the current active one was returned. Refer to checkoutLinesAdd and checkoutLinesUpdate to merge a cart with an active checkout. + """ + created: Boolean + checkoutErrors: [CheckoutError!]! + checkout: Checkout +} + +input CheckoutCreateInput { + """ + Slug of a channel in which to create a checkout. + """ + channel: String + + """ + A list of checkout lines, each containing information about an item in the checkout. + """ + lines: [CheckoutLineInput]! + + """ + The customer's email address. + """ + email: String + + """ + The mailing address to where the checkout will be shipped. Note: the address will be ignored if the checkout doesn't contain shippable items. + """ + shippingAddress: AddressInput + + """ + Billing address of the customer. + """ + billingAddress: AddressInput + + """ + Checkout language code. + """ + languageCode: LanguageCodeEnum +} + +input CheckoutLineInput { + """ + The number of items purchased. + """ + quantity: Int! + + """ + ID of the product variant. + """ + variantId: ID! +} + +""" +Sets the customer as the owner of the checkout. +""" +type CheckoutCustomerAttach { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated checkout. + """ + checkout: Checkout + checkoutErrors: [CheckoutError!]! +} + +""" +Removes the user assigned as the owner of the checkout. +""" +type CheckoutCustomerDetach { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated checkout. + """ + checkout: Checkout + checkoutErrors: [CheckoutError!]! +} + +""" +Updates email address in the existing checkout object. +""" +type CheckoutEmailUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated checkout. + """ + checkout: Checkout + checkoutErrors: [CheckoutError!]! +} + +""" +Deletes a CheckoutLine. +""" +type CheckoutLineDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated checkout. + """ + checkout: Checkout + checkoutErrors: [CheckoutError!]! +} + +""" +Adds a checkout line to the existing checkout. +""" +type CheckoutLinesAdd { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated checkout. + """ + checkout: Checkout + checkoutErrors: [CheckoutError!]! +} + +""" +Updates checkout line in the existing checkout. +""" +type CheckoutLinesUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated checkout. + """ + checkout: Checkout + checkoutErrors: [CheckoutError!]! +} + +""" +Remove a gift card or a voucher from a checkout. +""" +type CheckoutRemovePromoCode { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + The checkout with the removed gift card or voucher. + """ + checkout: Checkout + checkoutErrors: [CheckoutError!]! +} + +""" +Create a new payment for given checkout. +""" +type CheckoutPaymentCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Related checkout object. + """ + checkout: Checkout + + """ + A newly created payment. + """ + payment: Payment + paymentErrors: [PaymentError!]! +} + +input PaymentInput { + """ + A gateway to use with that payment. + """ + gateway: String! + + """ + Client-side generated payment token, representing customer's billing data in a secure manner. + """ + token: String + + """ + Total amount of the transaction, including all taxes and discounts. If no amount is provided, the checkout total will be used. + """ + amount: PositiveDecimal + + """ + URL of a storefront view where user should be redirected after requiring additional actions. Payment with additional actions will not be finished if this field is not provided. + """ + returnUrl: String +} + +""" +Update shipping address in the existing checkout. +""" +type CheckoutShippingAddressUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated checkout. + """ + checkout: Checkout + checkoutErrors: [CheckoutError!]! +} + +""" +Updates the shipping address of the checkout. +""" +type CheckoutShippingMethodUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated checkout. + """ + checkout: Checkout + checkoutErrors: [CheckoutError!]! +} + +""" +Update language code in the existing checkout. +""" +type CheckoutLanguageCodeUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated checkout. + """ + checkout: Checkout + checkoutErrors: [CheckoutError!]! +} + +""" +Creates new channel. +""" +type ChannelCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + channelErrors: [ChannelError!]! + channel: Channel +} + +type ChannelError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: ChannelErrorCode! + + """ + List of shipping zone IDs which causes the error. + """ + shippingZones: [ID!] +} + +""" +An enumeration. +""" +enum ChannelErrorCode { + ALREADY_EXISTS + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE + CHANNEL_TARGET_ID_MUST_BE_DIFFERENT + CHANNELS_CURRENCY_MUST_BE_THE_SAME + CHANNEL_WITH_ORDERS + DUPLICATED_INPUT_ITEM +} + +input ChannelCreateInput { + """ + isActive flag. + """ + isActive: Boolean + + """ + Name of the channel. + """ + name: String! + + """ + Slug of the channel. + """ + slug: String! + + """ + Currency of the channel. + """ + currencyCode: String! + + """ + List of shipping zones to assign to the channel. + """ + addShippingZones: [ID!] +} + +""" +Update a channel. +""" +type ChannelUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + channelErrors: [ChannelError!]! + channel: Channel +} + +input ChannelUpdateInput { + """ + isActive flag. + """ + isActive: Boolean + + """ + Name of the channel. + """ + name: String + + """ + Slug of the channel. + """ + slug: String + + """ + List of shipping zones to assign to the channel. + """ + addShippingZones: [ID!] + + """ + List of shipping zones to unassign from the channel. + """ + removeShippingZones: [ID!] +} + +""" +Delete a channel. Orders associated with the deleted channel will be moved to the target channel. Checkouts, product availability, and pricing will be removed. +""" +type ChannelDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + channelErrors: [ChannelError!]! + channel: Channel +} + +input ChannelDeleteInput { + """ + ID of channel to migrate orders from origin channel. + """ + targetChannel: ID! +} + +""" +Activate a channel. +""" +type ChannelActivate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Activated channel. + """ + channel: Channel + channelErrors: [ChannelError!]! +} + +""" +Deactivate a channel. +""" +type ChannelDeactivate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Deactivated channel. + """ + channel: Channel + channelErrors: [ChannelError!]! +} + +""" +Creates an attribute. +""" +type AttributeCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + attribute: Attribute + attributeErrors: [AttributeError!]! +} + +type AttributeError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: AttributeErrorCode! +} + +""" +An enumeration. +""" +enum AttributeErrorCode { + ALREADY_EXISTS + GRAPHQL_ERROR + INVALID + NOT_FOUND + REQUIRED + UNIQUE +} + +input AttributeCreateInput { + """ + The input type to use for entering attribute values in the dashboard. + """ + inputType: AttributeInputTypeEnum + + """ + The entity type which can be used as a reference. + """ + entityType: AttributeEntityTypeEnum + + """ + Name of an attribute displayed in the interface. + """ + name: String! + + """ + Internal representation of an attribute name. + """ + slug: String + + """ + The attribute type. + """ + type: AttributeTypeEnum! + + """ + List of attribute's values. + """ + values: [AttributeValueCreateInput] + + """ + Whether the attribute requires values to be passed or not. + """ + valueRequired: Boolean + + """ + Whether the attribute is for variants only. + """ + isVariantOnly: Boolean + + """ + Whether the attribute should be visible or not in storefront. + """ + visibleInStorefront: Boolean + + """ + Whether the attribute can be filtered in storefront. + """ + filterableInStorefront: Boolean + + """ + Whether the attribute can be filtered in dashboard. + """ + filterableInDashboard: Boolean + + """ + The position of the attribute in the storefront navigation (0 by default). + """ + storefrontSearchPosition: Int + + """ + Whether the attribute can be displayed in the admin product list. + """ + availableInGrid: Boolean +} + +input AttributeValueCreateInput { + """ + Name of a value displayed in the interface. + """ + name: String! + + """ + Represents the value of the attribute value. + """ + value: String + + """ + Represents the text (JSON) of the attribute value. + """ + richText: JSONString +} + +""" +Deletes an attribute. +""" +type AttributeDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + attributeErrors: [AttributeError!]! + attribute: Attribute +} + +""" +Updates attribute. +""" +type AttributeUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + attribute: Attribute + attributeErrors: [AttributeError!]! +} + +input AttributeUpdateInput { + """ + Name of an attribute displayed in the interface. + """ + name: String + + """ + Internal representation of an attribute name. + """ + slug: String + + """ + IDs of values to be removed from this attribute. + """ + removeValues: [ID] + + """ + New values to be created for this attribute. + """ + addValues: [AttributeValueCreateInput] + + """ + Whether the attribute requires values to be passed or not. + """ + valueRequired: Boolean + + """ + Whether the attribute is for variants only. + """ + isVariantOnly: Boolean + + """ + Whether the attribute should be visible or not in storefront. + """ + visibleInStorefront: Boolean + + """ + Whether the attribute can be filtered in storefront. + """ + filterableInStorefront: Boolean + + """ + Whether the attribute can be filtered in dashboard. + """ + filterableInDashboard: Boolean + + """ + The position of the attribute in the storefront navigation (0 by default). + """ + storefrontSearchPosition: Int + + """ + Whether the attribute can be displayed in the admin product list. + """ + availableInGrid: Boolean +} + +""" +Creates/Updates translations for attribute. +""" +type AttributeTranslate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + translationErrors: [TranslationError!]! + attribute: Attribute +} + +""" +Deletes attributes. +""" +type AttributeBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + attributeErrors: [AttributeError!]! +} + +""" +Deletes values of attributes. +""" +type AttributeValueBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + attributeErrors: [AttributeError!]! +} + +""" +Creates a value for an attribute. +""" +type AttributeValueCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + The updated attribute. + """ + attribute: Attribute + attributeErrors: [AttributeError!]! + attributeValue: AttributeValue +} + +""" +Deletes a value of an attribute. +""" +type AttributeValueDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + The updated attribute. + """ + attribute: Attribute + attributeErrors: [AttributeError!]! + attributeValue: AttributeValue +} + +""" +Updates value of an attribute. +""" +type AttributeValueUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + The updated attribute. + """ + attribute: Attribute + attributeErrors: [AttributeError!]! + attributeValue: AttributeValue +} + +""" +Creates/Updates translations for attribute value. +""" +type AttributeValueTranslate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + translationErrors: [TranslationError!]! + attributeValue: AttributeValue +} + +input AttributeValueTranslationInput { + name: String + richText: JSONString +} + +""" +Reorder the values of an attribute. +""" +type AttributeReorderValues { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Attribute from which values are reordered. + """ + attribute: Attribute + attributeErrors: [AttributeError!]! +} + +""" +Creates a new app. +""" +type AppCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + The newly created authentication token. + """ + authToken: String + appErrors: [AppError!]! + app: App +} + +type AppError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: AppErrorCode! + + """ + List of permissions which causes the error. + """ + permissions: [PermissionEnum!] +} + +""" +An enumeration. +""" +enum AppErrorCode { + FORBIDDEN + GRAPHQL_ERROR + INVALID + INVALID_STATUS + INVALID_PERMISSION + INVALID_URL_FORMAT + INVALID_MANIFEST_FORMAT + MANIFEST_URL_CANT_CONNECT + NOT_FOUND + REQUIRED + UNIQUE + OUT_OF_SCOPE_APP + OUT_OF_SCOPE_PERMISSION +} + +input AppInput { + """ + Name of the app. + """ + name: String + + """ + DEPRECATED: Use the `appActivate` and `appDeactivate` mutations instead. This field will be removed after 2020-07-31. + """ + isActive: Boolean + + """ + List of permission code names to assign to this app. + """ + permissions: [PermissionEnum] +} + +""" +Updates an existing app. +""" +type AppUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + appErrors: [AppError!]! + app: App +} + +""" +Deletes an app. +""" +type AppDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + appErrors: [AppError!]! + app: App +} + +""" +Creates a new token. +""" +type AppTokenCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + The newly created authentication token. + """ + authToken: String + appErrors: [AppError!]! + appToken: AppToken +} + +input AppTokenInput { + """ + Name of the token. + """ + name: String + + """ + ID of app. + """ + app: ID! +} + +""" +Deletes an authentication token assigned to app. +""" +type AppTokenDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + appErrors: [AppError!]! + appToken: AppToken +} + +""" +Verify provided app token. +""" +type AppTokenVerify { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Determine if token is valid or not. + """ + valid: Boolean! + appErrors: [AppError!]! +} + +""" +Install new app by using app manifest. +""" +type AppInstall { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + appErrors: [AppError!]! + appInstallation: AppInstallation +} + +input AppInstallInput { + """ + Name of the app to install. + """ + appName: String + + """ + Url to app's manifest in JSON format. + """ + manifestUrl: String + + """ + Determine if app will be set active or not. + """ + activateAfterInstallation: Boolean + + """ + List of permission code names to assign to this app. + """ + permissions: [PermissionEnum] +} + +""" +Retry failed installation of new app. +""" +type AppRetryInstall { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + appErrors: [AppError!]! + appInstallation: AppInstallation +} + +""" +Delete failed installation. +""" +type AppDeleteFailedInstallation { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + appErrors: [AppError!]! + appInstallation: AppInstallation +} + +""" +Fetch and validate manifest. +""" +type AppFetchManifest { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + manifest: Manifest + appErrors: [AppError!]! +} + +""" +The manifest definition. +""" +type Manifest { + identifier: String! + version: String! + name: String! + about: String + permissions: [Permission] + appUrl: String + configurationUrl: String + tokenTargetUrl: String + dataPrivacy: String + dataPrivacyUrl: String + homepageUrl: String + supportUrl: String +} + +""" +Activate the app. +""" +type AppActivate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + appErrors: [AppError!]! + app: App +} + +""" +Deactivate the app. +""" +type AppDeactivate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + appErrors: [AppError!]! + app: App +} + +""" +Create JWT token. +""" +type CreateToken { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + JWT token, required to authenticate. + """ + token: String + + """ + JWT refresh token, required to re-generate access token. + """ + refreshToken: String + + """ + CSRF token required to re-generate access token. + """ + csrfToken: String + + """ + A user instance. + """ + user: User + accountErrors: [AccountError!]! +} + +type AccountError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: AccountErrorCode! +} + +""" +An enumeration. +""" +enum AccountErrorCode { + ACTIVATE_OWN_ACCOUNT + ACTIVATE_SUPERUSER_ACCOUNT + DUPLICATED_INPUT_ITEM + DEACTIVATE_OWN_ACCOUNT + DEACTIVATE_SUPERUSER_ACCOUNT + DELETE_NON_STAFF_USER + DELETE_OWN_ACCOUNT + DELETE_STAFF_ACCOUNT + DELETE_SUPERUSER_ACCOUNT + GRAPHQL_ERROR + INACTIVE + INVALID + INVALID_PASSWORD + LEFT_NOT_MANAGEABLE_PERMISSION + INVALID_CREDENTIALS + NOT_FOUND + OUT_OF_SCOPE_USER + OUT_OF_SCOPE_GROUP + OUT_OF_SCOPE_PERMISSION + PASSWORD_ENTIRELY_NUMERIC + PASSWORD_TOO_COMMON + PASSWORD_TOO_SHORT + PASSWORD_TOO_SIMILAR + REQUIRED + UNIQUE + JWT_SIGNATURE_EXPIRED + JWT_INVALID_TOKEN + JWT_DECODE_ERROR + JWT_MISSING_TOKEN + JWT_INVALID_CSRF_TOKEN +} + +""" +Refresh JWT token. Mutation tries to take refreshToken from the input.If it fails it will try to take refreshToken from the http-only cookie -refreshToken. csrfToken is required when refreshToken is provided as a cookie. +""" +type RefreshToken { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + JWT token, required to authenticate. + """ + token: String + + """ + A user instance. + """ + user: User + accountErrors: [AccountError!]! +} + +""" +Verify JWT token. +""" +type VerifyToken { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + User assigned to token. + """ + user: User + + """ + Determine if token is valid or not. + """ + isValid: Boolean! + + """ + JWT payload. + """ + payload: GenericScalar + accountErrors: [AccountError!]! +} + +""" +The `GenericScalar` scalar type represents a generic +GraphQL scalar value that could be: +String, Boolean, Int, Float, List or Object. +""" +scalar GenericScalar + +""" +Deactivate all JWT tokens of the currently authenticated user. +""" +type DeactivateAllUserTokens { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + accountErrors: [AccountError!]! +} + +""" +Prepare external authentication url for user by custom plugin. +""" +type ExternalAuthenticationUrl { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + The data returned by authentication plugin. + """ + authenticationData: JSONString + accountErrors: [AccountError!]! +} + +""" +Obtain external access tokens for user by custom plugin. +""" +type ExternalObtainAccessTokens { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + The token, required to authenticate. + """ + token: String + + """ + The refresh token, required to re-generate external access token. + """ + refreshToken: String + + """ + CSRF token required to re-generate external access token. + """ + csrfToken: String + + """ + A user instance. + """ + user: User + accountErrors: [AccountError!]! +} + +""" +Refresh user's access by custom plugin. +""" +type ExternalRefresh { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + The token, required to authenticate. + """ + token: String + + """ + The refresh token, required to re-generate external access token. + """ + refreshToken: String + + """ + CSRF token required to re-generate external access token. + """ + csrfToken: String + + """ + A user instance. + """ + user: User + accountErrors: [AccountError!]! +} + +""" +Logout user by custom plugin. +""" +type ExternalLogout { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + The data returned by authentication plugin. + """ + logoutData: JSONString + accountErrors: [AccountError!]! +} + +""" +Verify external authentication data by plugin. +""" +type ExternalVerify { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + User assigned to data. + """ + user: User + + """ + Determine if authentication data is valid or not. + """ + isValid: Boolean! + + """ + External data. + """ + verifyData: JSONString + accountErrors: [AccountError!]! +} + +""" +Sends an email with the account password modification link. +""" +type RequestPasswordReset { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + accountErrors: [AccountError!]! +} + +""" +Confirm user account with token sent by email during registration. +""" +type ConfirmAccount { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An activated user account. + """ + user: User + accountErrors: [AccountError!]! +} + +""" +Sets the user's password from the token sent by email using the RequestPasswordReset mutation. +""" +type SetPassword { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + JWT token, required to authenticate. + """ + token: String + + """ + JWT refresh token, required to re-generate access token. + """ + refreshToken: String + + """ + CSRF token required to re-generate access token. + """ + csrfToken: String + + """ + A user instance. + """ + user: User + accountErrors: [AccountError!]! +} + +""" +Change the password of the logged in user. +""" +type PasswordChange { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A user instance with a new password. + """ + user: User + accountErrors: [AccountError!]! +} + +""" +Request email change of the logged in user. +""" +type RequestEmailChange { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A user instance. + """ + user: User + accountErrors: [AccountError!]! +} + +""" +Confirm the email change of the logged-in user. +""" +type ConfirmEmailChange { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A user instance with a new email. + """ + user: User + accountErrors: [AccountError!]! +} + +""" +Create a new address for the customer. +""" +type AccountAddressCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A user instance for which the address was created. + """ + user: User + accountErrors: [AccountError!]! + address: Address +} + +""" +An enumeration. +""" +enum AddressTypeEnum { + BILLING + SHIPPING +} + +""" +Updates an address of the logged-in user. +""" +type AccountAddressUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A user object for which the address was edited. + """ + user: User + accountErrors: [AccountError!]! + address: Address +} + +""" +Delete an address of the logged-in user. +""" +type AccountAddressDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A user instance for which the address was deleted. + """ + user: User + accountErrors: [AccountError!]! + address: Address +} + +""" +Sets a default address for the authenticated user. +""" +type AccountSetDefaultAddress { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated user instance. + """ + user: User + accountErrors: [AccountError!]! +} + +""" +Register a new user. +""" +type AccountRegister { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Informs whether users need to confirm their email address. + """ + requiresConfirmation: Boolean + accountErrors: [AccountError!]! + user: User +} + +input AccountRegisterInput { + """ + The email address of the user. + """ + email: String! + + """ + Password. + """ + password: String! + + """ + Base of frontend URL that will be needed to create confirmation URL. + """ + redirectUrl: String + + """ + User language code. + """ + languageCode: LanguageCodeEnum +} + +""" +Updates the account of the logged-in user. +""" +type AccountUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + accountErrors: [AccountError!]! + user: User +} + +input AccountInput { + """ + Given name. + """ + firstName: String + + """ + Family name. + """ + lastName: String + + """ + Billing address of the customer. + """ + defaultBillingAddress: AddressInput + + """ + Shipping address of the customer. + """ + defaultShippingAddress: AddressInput + + """ + User language code. + """ + languageCode: LanguageCodeEnum +} + +""" +Sends an email with the account removal link for the logged-in user. +""" +type AccountRequestDeletion { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + accountErrors: [AccountError!]! +} + +""" +Remove user account. +""" +type AccountDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + accountErrors: [AccountError!]! + user: User +} + +""" +Creates user address. +""" +type AddressCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A user instance for which the address was created. + """ + user: User + accountErrors: [AccountError!]! + address: Address +} + +""" +Updates an address. +""" +type AddressUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A user object for which the address was edited. + """ + user: User + accountErrors: [AccountError!]! + address: Address +} + +""" +Deletes an address. +""" +type AddressDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + A user instance for which the address was deleted. + """ + user: User + accountErrors: [AccountError!]! + address: Address +} + +""" +Sets a default address for the given user. +""" +type AddressSetDefault { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated user instance. + """ + user: User + accountErrors: [AccountError!]! +} + +""" +Creates a new customer. +""" +type CustomerCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + accountErrors: [AccountError!]! + user: User +} + +input UserCreateInput { + """ + Billing address of the customer. + """ + defaultBillingAddress: AddressInput + + """ + Shipping address of the customer. + """ + defaultShippingAddress: AddressInput + + """ + Given name. + """ + firstName: String + + """ + Family name. + """ + lastName: String + + """ + The unique email address of the user. + """ + email: String + + """ + User account is active. + """ + isActive: Boolean + + """ + A note about the user. + """ + note: String + + """ + User language code. + """ + languageCode: LanguageCodeEnum + + """ + URL of a view where users should be redirected to set the password. URL in RFC 1808 format. + """ + redirectUrl: String +} + +""" +Updates an existing customer. +""" +type CustomerUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + accountErrors: [AccountError!]! + user: User +} + +input CustomerInput { + """ + Billing address of the customer. + """ + defaultBillingAddress: AddressInput + + """ + Shipping address of the customer. + """ + defaultShippingAddress: AddressInput + + """ + Given name. + """ + firstName: String + + """ + Family name. + """ + lastName: String + + """ + The unique email address of the user. + """ + email: String + + """ + User account is active. + """ + isActive: Boolean + + """ + A note about the user. + """ + note: String + + """ + User language code. + """ + languageCode: LanguageCodeEnum +} + +""" +Deletes a customer. +""" +type CustomerDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + accountErrors: [AccountError!]! + user: User +} + +""" +Deletes customers. +""" +type CustomerBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + accountErrors: [AccountError!]! +} + +""" +Creates a new staff user. +""" +type StaffCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + staffErrors: [StaffError!]! + user: User +} + +type StaffError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: AccountErrorCode! + + """ + List of permissions which causes the error. + """ + permissions: [PermissionEnum!] + + """ + List of permission group IDs which cause the error. + """ + groups: [ID!] + + """ + List of user IDs which causes the error. + """ + users: [ID!] +} + +input StaffCreateInput { + """ + Given name. + """ + firstName: String + + """ + Family name. + """ + lastName: String + + """ + The unique email address of the user. + """ + email: String + + """ + User account is active. + """ + isActive: Boolean + + """ + A note about the user. + """ + note: String + + """ + List of permission group IDs to which user should be assigned. + """ + addGroups: [ID!] + + """ + URL of a view where users should be redirected to set the password. URL in RFC 1808 format. + """ + redirectUrl: String +} + +""" +Updates an existing staff user. +""" +type StaffUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + staffErrors: [StaffError!]! + user: User +} + +input StaffUpdateInput { + """ + Given name. + """ + firstName: String + + """ + Family name. + """ + lastName: String + + """ + The unique email address of the user. + """ + email: String + + """ + User account is active. + """ + isActive: Boolean + + """ + A note about the user. + """ + note: String + + """ + List of permission group IDs to which user should be assigned. + """ + addGroups: [ID!] + + """ + List of permission group IDs from which user should be unassigned. + """ + removeGroups: [ID!] +} + +""" +Deletes a staff user. +""" +type StaffDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + staffErrors: [StaffError!]! + user: User +} + +""" +Deletes staff users. +""" +type StaffBulkDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + staffErrors: [StaffError!]! +} + +""" +Create a user avatar. Only for staff members. This mutation must be sent as a `multipart` request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec +""" +type UserAvatarUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated user instance. + """ + user: User + accountErrors: [AccountError!]! +} + +""" +Deletes a user avatar. Only for staff members. +""" +type UserAvatarDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + An updated user instance. + """ + user: User + accountErrors: [AccountError!]! +} + +""" +Activate or deactivate users. +""" +type UserBulkSetActive { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + + """ + Returns how many objects were affected. + """ + count: Int! + accountErrors: [AccountError!]! +} + +""" +Create new permission group. +""" +type PermissionGroupCreate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + permissionGroupErrors: [PermissionGroupError!]! + group: Group +} + +type PermissionGroupError { + """ + Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field. + """ + field: String + + """ + The error message. + """ + message: String + + """ + The error code. + """ + code: PermissionGroupErrorCode! + + """ + List of permissions which causes the error. + """ + permissions: [PermissionEnum!] + + """ + List of user IDs which causes the error. + """ + users: [ID!] +} + +""" +An enumeration. +""" +enum PermissionGroupErrorCode { + ASSIGN_NON_STAFF_MEMBER + DUPLICATED_INPUT_ITEM + CANNOT_REMOVE_FROM_LAST_GROUP + LEFT_NOT_MANAGEABLE_PERMISSION + OUT_OF_SCOPE_PERMISSION + OUT_OF_SCOPE_USER + REQUIRED + UNIQUE +} + +input PermissionGroupCreateInput { + """ + List of permission code names to assign to this group. + """ + addPermissions: [PermissionEnum!] + + """ + List of users to assign to this group. + """ + addUsers: [ID!] + + """ + Group name. + """ + name: String! +} + +""" +Update permission group. +""" +type PermissionGroupUpdate { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + permissionGroupErrors: [PermissionGroupError!]! + group: Group +} + +input PermissionGroupUpdateInput { + """ + List of permission code names to assign to this group. + """ + addPermissions: [PermissionEnum!] + + """ + List of users to assign to this group. + """ + addUsers: [ID!] + + """ + Group name. + """ + name: String + + """ + List of permission code names to unassign from this group. + """ + removePermissions: [PermissionEnum!] + + """ + List of users to unassign from this group. + """ + removeUsers: [ID!] +} + +""" +Delete permission group. +""" +type PermissionGroupDelete { + """ + List of errors that occurred executing the mutation. + """ + errors: [Error!]! + @deprecated( + reason: "Use typed errors with error codes. This field will be removed after 2020-07-31." + ) + permissionGroupErrors: [PermissionGroupError!]! + group: Group } diff --git a/framework/saleor/utils/get-categories.ts b/framework/saleor/utils/get-categories.ts index 38f22c906..19db88d28 100644 --- a/framework/saleor/utils/get-categories.ts +++ b/framework/saleor/utils/get-categories.ts @@ -11,16 +11,16 @@ export type Category = { const getCategories = async (config: SaleorConfig): Promise => { const { data } = await config.fetch(getSiteCollectionsQuery, { variables: { - first: 250, + first: 100, }, }) return ( data.collections?.edges?.map( - ({ node: { id: entityId, title: name, handle } }: CollectionEdge) => ({ + ({ node: { id: entityId, name, slug } }: CollectionEdge) => ({ entityId, name, - path: `/${handle}`, + path: `/${slug}`, }) ) ?? [] ) diff --git a/framework/saleor/utils/get-vendors.ts b/framework/saleor/utils/get-vendors.ts index 19a686445..4814646ec 100644 --- a/framework/saleor/utils/get-vendors.ts +++ b/framework/saleor/utils/get-vendors.ts @@ -14,27 +14,30 @@ export type BrandEdge = { export type Brands = BrandEdge[] +// TODO: Find a way to get vendors from meta const getVendors = async (config: SaleorConfig): Promise => { - const vendors = await fetchAllProducts({ - config, - query: getAllProductVendors, - variables: { - first: 250, - }, - }) + // const vendors = await fetchAllProducts({ + // config, + // query: getAllProductVendors, + // variables: { + // first: 100, + // }, + // }) - let vendorsStrings = vendors.map(({ node: { vendor } }) => vendor) + // let vendorsStrings = vendors.map(({ node: { vendor } }) => vendor) - return [...new Set(vendorsStrings)].map((v) => { - const id = v.replace(/\s+/g, '-').toLowerCase() - return { - node: { - entityId: id, - name: v, - path: `brands/${id}`, - }, - } - }) + // return [...new Set(vendorsStrings)].map((v) => { + // const id = v.replace(/\s+/g, '-').toLowerCase() + // return { + // node: { + // entityId: id, + // name: v, + // path: `brands/${id}`, + // }, + // } + // }) + + return [] } export default getVendors diff --git a/framework/saleor/utils/mutations/checkout-create.ts b/framework/saleor/utils/mutations/checkout-create.ts index ffbd555c7..aceae0943 100644 --- a/framework/saleor/utils/mutations/checkout-create.ts +++ b/framework/saleor/utils/mutations/checkout-create.ts @@ -1,16 +1,17 @@ import { checkoutDetailsFragment } from '../queries/get-checkout-query' const checkoutCreateMutation = /* GraphQL */ ` - mutation { + mutation createCheckout { checkoutCreate(input: {}) { checkoutUserErrors { code field message } - checkout { - ${checkoutDetailsFragment} - } + # Breaks GraphQL Codegen + # checkout { + # ${checkoutDetailsFragment} + # } } } ` diff --git a/framework/saleor/utils/mutations/checkout-line-item-add.ts b/framework/saleor/utils/mutations/checkout-line-item-add.ts index 2282c4e26..a41268571 100644 --- a/framework/saleor/utils/mutations/checkout-line-item-add.ts +++ b/framework/saleor/utils/mutations/checkout-line-item-add.ts @@ -1,16 +1,16 @@ import { checkoutDetailsFragment } from '../queries/get-checkout-query' const checkoutLineItemAddMutation = /* GraphQL */ ` - mutation($checkoutId: ID!, $lineItems: [CheckoutLineItemInput!]!) { + mutation checkoutLineItemAdd($checkoutId: ID!, $lineItems: [CheckoutLineItemInput!]!) { checkoutLineItemsAdd(checkoutId: $checkoutId, lineItems: $lineItems) { checkoutUserErrors { code field message } - checkout { - ${checkoutDetailsFragment} - } + # checkout { + # ${checkoutDetailsFragment} + # } } } ` diff --git a/framework/saleor/utils/mutations/checkout-line-item-remove.ts b/framework/saleor/utils/mutations/checkout-line-item-remove.ts index 8dea4ce08..548130139 100644 --- a/framework/saleor/utils/mutations/checkout-line-item-remove.ts +++ b/framework/saleor/utils/mutations/checkout-line-item-remove.ts @@ -1,7 +1,7 @@ import { checkoutDetailsFragment } from '../queries/get-checkout-query' const checkoutLineItemRemoveMutation = /* GraphQL */ ` - mutation($checkoutId: ID!, $lineItemIds: [ID!]!) { + mutation checkoutLineItemRemove($checkoutId: ID!, $lineItemIds: [ID!]!) { checkoutLineItemsRemove( checkoutId: $checkoutId lineItemIds: $lineItemIds @@ -11,9 +11,9 @@ const checkoutLineItemRemoveMutation = /* GraphQL */ ` field message } - checkout { - ${checkoutDetailsFragment} - } + # checkout { + # ${checkoutDetailsFragment} + # } } } ` diff --git a/framework/saleor/utils/mutations/checkout-line-item-update.ts b/framework/saleor/utils/mutations/checkout-line-item-update.ts index 76254341e..a5b9e51ff 100644 --- a/framework/saleor/utils/mutations/checkout-line-item-update.ts +++ b/framework/saleor/utils/mutations/checkout-line-item-update.ts @@ -1,16 +1,16 @@ import { checkoutDetailsFragment } from '../queries/get-checkout-query' const checkoutLineItemUpdateMutation = /* GraphQL */ ` - mutation($checkoutId: ID!, $lineItems: [CheckoutLineItemUpdateInput!]!) { + mutation checkoutLineItemUpdate($checkoutId: ID!, $lineItems: [CheckoutLineItemUpdateInput!]!) { checkoutLineItemsUpdate(checkoutId: $checkoutId, lineItems: $lineItems) { checkoutUserErrors { code field message } - checkout { - ${checkoutDetailsFragment} - } + # checkout { + # ${checkoutDetailsFragment} + # } } } ` diff --git a/framework/saleor/utils/normalize.ts b/framework/saleor/utils/normalize.ts index 3161f9f9e..62c3eeccd 100644 --- a/framework/saleor/utils/normalize.ts +++ b/framework/saleor/utils/normalize.ts @@ -9,67 +9,68 @@ import { ProductVariantConnection, MoneyV2, ProductOption, + Money, } from '../schema' import type { Cart, LineItem } from '../types' -const money = ({ amount, currencyCode }: MoneyV2) => { +const money = ({ amount, currency }: Money) => { return { value: +amount, - currencyCode, + currencyCode: currency || 'USD', } } -const normalizeProductOption = ({ - id, - name: displayName, - values, -}: ProductOption) => { - return { +const normalizeProductOptions = (options: ProductOption[]) => { + return options?.map(({ id, name: displayName, values }) => ({ __typename: 'MultipleChoiceOption', id, displayName, - values: values.map((value) => { - let output: any = { - label: value, - } - if (displayName.match(/colou?r/gi)) { - output = { - ...output, - hexColors: [value], - } - } - return output - }), - } + // values: values.map((value) => { + // let output: any = { + // label: value, + // } + // if (displayName.match(/colou?r/gi)) { + // output = { + // ...output, + // hexColors: [value], + // } + // } + // return output + // }) + values: [], + })) } -const normalizeProductImages = ({ edges }: ImageConnection) => - edges?.map(({ node: { originalSrc: url, ...rest } }) => ({ +const normalizeProductImages = (images: any) => + images.map(({ node: { originalSrc: url, ...rest } }) => ({ url, ...rest, })) -const normalizeProductVariants = ({ edges }: ProductVariantConnection) => { - return edges?.map( - ({ - node: { id, selectedOptions, sku, title, priceV2, compareAtPriceV2 }, - }) => { +const normalizeProductVariants = (variants: any) => { + return variants?.map( + ({ id, selectedOptions, sku, name, priceV2, pricing }) => { + const price = money(pricing?.price?.net)?.value + + console.log({ price }) + return { id, - name: title, + name, sku: sku ?? id, - price: +priceV2.amount, - listPrice: +compareAtPriceV2?.amount, + price, + listPrice: price, requiresShipping: true, - options: selectedOptions.map(({ name, value }: SelectedOption) => { - const options = normalizeProductOption({ - id, - name, - values: [value], - }) - return options - }), + // options: selectedOptions.map(({ name, value }: SelectedOption) => { + // const options = normalizeProductOption({ + // id, + // name, + // values: [value], + // }) + // return options + // }), + options: [], } } ) @@ -78,28 +79,27 @@ const normalizeProductVariants = ({ edges }: ProductVariantConnection) => { export function normalizeProduct(productNode: SaleorProduct): Product { const { id, - title: name, - vendor, - images, + name, + media, variants, description, - handle, - priceRange, - options, + slug, + pricing, + // options, ...rest } = productNode const product = { id, name, - vendor, + vendor: '', description, - path: `/${handle}`, - slug: handle?.replace(/^\/+|\/+$/g, ''), - price: money(priceRange?.minVariantPrice), - images: normalizeProductImages(images), + path: `/${slug}`, + slug: slug?.replace(/^\/+|\/+$/g, ''), + price: money(pricing?.priceRange?.start?.net) || 0, + images: media, variants: variants ? normalizeProductVariants(variants) : [], - options: options ? options.map((o) => normalizeProductOption(o)) : [], + options: variants ? normalizeProductOptions(variants) : [], ...rest, } diff --git a/framework/saleor/utils/queries/get-all-collections-query.ts b/framework/saleor/utils/queries/get-all-collections-query.ts index 2abf374d6..c664ab1a1 100644 --- a/framework/saleor/utils/queries/get-all-collections-query.ts +++ b/framework/saleor/utils/queries/get-all-collections-query.ts @@ -1,11 +1,11 @@ const getSiteCollectionsQuery = /* GraphQL */ ` - query getSiteCollections($first: Int!) { - collections(first: $first) { + query getSiteCollections($first: Int!, $channel: String = "default-channel") { + collections(first: $first, channel: $channel) { edges { node { id - title - handle + name + slug } } } diff --git a/framework/saleor/utils/queries/get-all-pages-query.ts b/framework/saleor/utils/queries/get-all-pages-query.ts index e3aee1f10..21912ddb8 100644 --- a/framework/saleor/utils/queries/get-all-pages-query.ts +++ b/framework/saleor/utils/queries/get-all-pages-query.ts @@ -1,11 +1,11 @@ export const getAllPagesQuery = /* GraphQL */ ` - query getAllPages($first: Int = 250) { + query getAllPages($first: Int = 100) { pages(first: $first) { edges { node { id title - handle + slug } } } diff --git a/framework/saleor/utils/queries/get-all-products-paths-query.ts b/framework/saleor/utils/queries/get-all-products-paths-query.ts index 56298c204..7773104fc 100644 --- a/framework/saleor/utils/queries/get-all-products-paths-query.ts +++ b/framework/saleor/utils/queries/get-all-products-paths-query.ts @@ -1,13 +1,17 @@ const getAllProductsPathsQuery = /* GraphQL */ ` - query getAllProductPaths($first: Int = 250, $cursor: String) { - products(first: $first, after: $cursor) { + query getAllProductPaths( + $first: Int = 100 + $cursor: String + $channel: String = "default-channel" + ) { + products(first: $first, after: $cursor, channel: $channel) { pageInfo { hasNextPage hasPreviousPage } edges { node { - handle + slug } cursor } diff --git a/framework/saleor/utils/queries/get-all-products-query.ts b/framework/saleor/utils/queries/get-all-products-query.ts index 5eb44c7a7..87be83868 100644 --- a/framework/saleor/utils/queries/get-all-products-query.ts +++ b/framework/saleor/utils/queries/get-all-products-query.ts @@ -1,57 +1,42 @@ -export const productConnection = ` -pageInfo { - hasNextPage - hasPreviousPage -} -edges { - node { - id - title - vendor - handle - description - priceRange { - minVariantPrice { - amount - currencyCode - } +export const productConnection = /* GraphQL */ ` + fragment productConnnection on ProductCountableConnection { + pageInfo { + hasNextPage + hasPreviousPage } - images(first: 1) { - pageInfo { - hasNextPage - hasPreviousPage - } - edges { - node { - originalSrc - altText - width - height + edges { + node { + id + name + description + slug + pricing { + priceRange { + start { + net { + amount + } + } + } + } + media { + url + alt } } } } -}` - -export const productsFragment = ` -products( - first: $first - sortKey: $sortKey - reverse: $reverse - query: $query -) { - ${productConnection} -} ` const getAllProductsQuery = /* GraphQL */ ` query getAllProducts( - $first: Int = 250 - $query: String = "" - $sortKey: ProductSortKeys = RELEVANCE - $reverse: Boolean = false + $first: Int = 100 + $channel: String = "default-channel" ) { - ${productsFragment} + products(first: $first, channel: $channel) { + ...productConnnection + } } + ${productConnection} ` export default getAllProductsQuery diff --git a/framework/saleor/utils/queries/get-product-query.ts b/framework/saleor/utils/queries/get-product-query.ts index 5c109901b..bd857022d 100644 --- a/framework/saleor/utils/queries/get-product-query.ts +++ b/framework/saleor/utils/queries/get-product-query.ts @@ -1,66 +1,34 @@ const getProductQuery = /* GraphQL */ ` - query getProductBySlug($slug: String!) { - productByHandle(handle: $slug) { + query getProductBySlug($slug: String!, $channel: String = "default-channel") { + product(slug: $slug, channel: $channel) { id - handle - title - productType - vendor + slug + name description - descriptionHtml - options { + pricing { + priceRange { + start { + net { + amount + } + } + } + } + variants { id name - values - } - priceRange { - maxVariantPrice { - amount - currencyCode - } - minVariantPrice { - amount - currencyCode - } - } - variants(first: 250) { - pageInfo { - hasNextPage - hasPreviousPage - } - edges { - node { - id - title - sku - selectedOptions { - name - value - } - priceV2 { + pricing { + price { + net { amount - currencyCode - } - compareAtPriceV2 { - amount - currencyCode + currency } } } } - images(first: 250) { - pageInfo { - hasNextPage - hasPreviousPage - } - edges { - node { - originalSrc - altText - width - height - } - } + images { + url + alt } } } diff --git a/next.config.js b/next.config.js index 607d4eba8..ec8954c10 100644 --- a/next.config.js +++ b/next.config.js @@ -7,6 +7,7 @@ const { const provider = commerce.provider || getProviderName() const isBC = provider === 'bigcommerce' const isShopify = provider === 'shopify' +const isSaleor = provider === 'saleor' const isSwell = provider === 'swell' const isVendure = provider === 'vendure' @@ -16,6 +17,9 @@ module.exports = withCommerceConfig({ locales: ['en-US', 'es'], defaultLocale: 'en-US', }, + images: { + domains: [process.env.COMMERCE_IMAGE_HOST], + }, rewrites() { return [ (isBC || isShopify || isSwell || isVendure) && { diff --git a/tsconfig.json b/tsconfig.json index 96e4359e5..ba333b642 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -22,8 +22,8 @@ "@components/*": ["components/*"], "@commerce": ["framework/commerce"], "@commerce/*": ["framework/commerce/*"], - "@framework": ["framework/shopify"], - "@framework/*": ["framework/shopify/*"] + "@framework": ["framework/saleor"], + "@framework/*": ["framework/saleor/*"] } }, "include": ["next-env.d.ts", "**/*.d.ts", "**/*.ts", "**/*.tsx", "**/*.js"], diff --git a/yarn.lock b/yarn.lock index 1b1fce30e..74af1ec67 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5517,11 +5517,6 @@ quick-lru@^4.0.1: resolved "https://registry.yarnpkg.com/quick-lru/-/quick-lru-4.0.1.tgz#5b8878f113a58217848c6482026c73e1ba57727f" integrity sha512-ARhCpm70fzdcvNQfPoy49IaanKkTlRWF2JMzqhcJbhSFRZv7nPTvZJdcY7301IPmvW+/p0RgIWnQDLJxifsQ7g== -quick-lru@^5.1.1: - version "5.1.1" - resolved "https://registry.yarnpkg.com/quick-lru/-/quick-lru-5.1.1.tgz#366493e6b3e42a3a6885e2e99d18f80fb7a8c932" - integrity sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA== - randombytes@^2.0.0, randombytes@^2.0.1, randombytes@^2.0.5: version "2.1.0" resolved "https://registry.yarnpkg.com/randombytes/-/randombytes-2.1.0.tgz#df6f84372f0270dc65cdf6291349ab7a473d4f2a"